com.helger.schematron.pure.model

Class PSSpan

java.lang.Object

com.helger.schematron.pure.model.PSSpan

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<PSSpan>, IPSClonableElement<PSSpan>, IPSElement, IPSHasForeignAttributes, IPSHasForeignElements, IPSHasTexts, IPSOptionalElement, Serializable

@NotThreadSafe
public class PSSpan
extends Object
implements IPSClonableElement<PSSpan>, IPSOptionalElement, IPSHasForeignElements, IPSHasTexts

A single Schematron span-element.
A portion of some paragraph that should be rendered in a distinct way, keyed with the class attribute.
An implementation is not required to make use of this element.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PSSpan()

Method Summary

Modifier and Type	Method and Description
void	addForeignAttribute(String sAttrName, String sAttrValue)
void	addForeignElement(com.helger.xml.microdom.IMicroElement aForeignElement)
void	addText(String sText) Add a new text element.
com.helger.commons.collection.ext.ICommonsOrderedMap<String,String>	getAllForeignAttributes()
com.helger.commons.collection.ext.ICommonsList<com.helger.xml.microdom.IMicroElement>	getAllForeignElements()
com.helger.commons.collection.ext.ICommonsList<String>	getAllTexts()
com.helger.xml.microdom.IMicroElement	getAsMicroElement()
String	getAsText()
String	getClazz()
PSSpan	getClone()
boolean	hasAnyText()
boolean	hasForeignAttributes()
boolean	hasForeignElements()
boolean	isMinimal()
boolean	isValid(IPSErrorHandler aErrorHandler) Check if this element is specified completely.
void	setClazz(String sClass)
String	toString()
void	validateCompletely(IPSErrorHandler aErrorHandler) Check if this element is specified completely.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.schematron.pure.model.IPSHasForeignElements

addForeignElements

Methods inherited from interface com.helger.schematron.pure.model.IPSHasForeignAttributes

addForeignAttributes

Constructor Detail

PSSpan

public PSSpan()

Method Detail

isValid

public boolean isValid(@Nonnull
                       IPSErrorHandler aErrorHandler)

Description copied from interface: IPSElement

Check if this element is specified completely. This method stops at the first encountered error.

Specified by:

isValid in interface IPSElement

Parameters:

aErrorHandler - The error handler where the error details are stored. May not be null.

Returns:

true if all mandatory fields are set and the element is valid, false otherwise.

validateCompletely

public void validateCompletely(@Nonnull
                               IPSErrorHandler aErrorHandler)

Description copied from interface: IPSElement

Check if this element is specified completely. This method performs all validations independent of the number of encountered error.

Specified by:

validateCompletely in interface IPSElement

Parameters:

aErrorHandler - The error handler where the error details are stored. May not be null.

isMinimal

public boolean isMinimal()

Specified by:

isMinimal in interface IPSElement

Returns:

true if this element conforms to the Schematron minimal syntax, false otherwise.

addForeignElement

public void addForeignElement(@Nonnull
                              com.helger.xml.microdom.IMicroElement aForeignElement)

Specified by:

addForeignElement in interface IPSHasForeignElements

hasForeignElements

public boolean hasForeignElements()

Specified by:

hasForeignElements in interface IPSHasForeignElements

getAllForeignElements

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<com.helger.xml.microdom.IMicroElement> getAllForeignElements()

Specified by:

getAllForeignElements in interface IPSHasForeignElements

addForeignAttribute

public void addForeignAttribute(@Nonnull
                                String sAttrName,
                                @Nonnull
                                String sAttrValue)

Specified by:

addForeignAttribute in interface IPSHasForeignAttributes

hasForeignAttributes

public boolean hasForeignAttributes()

Specified by:

hasForeignAttributes in interface IPSHasForeignAttributes

getAllForeignAttributes

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsOrderedMap<String,String> getAllForeignAttributes()

Specified by:

getAllForeignAttributes in interface IPSHasForeignAttributes

setClazz

public void setClazz(@Nullable
                     String sClass)

getClazz

@Nullable
public String getClazz()

addText

public void addText(@Nonnull @Nonempty
                    String sText)

Description copied from interface: IPSHasTexts

Add a new text element.

Specified by:

addText in interface IPSHasTexts

Parameters:

sText - The text to be added. May not be null.

hasAnyText

public boolean hasAnyText()

Specified by:

hasAnyText in interface IPSHasTexts

Returns:

true if at least one text element is contained, false if not

getAllTexts

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<String> getAllTexts()

Specified by:

getAllTexts in interface IPSHasTexts

Returns:

A copy of all contained text elements. Never null.

getAsText

@Nullable
public String getAsText()

getAsMicroElement

@Nonnull
public com.helger.xml.microdom.IMicroElement getAsMicroElement()

Specified by:

getAsMicroElement in interface IPSElement

Returns:

The XML representation of this element. Never null.

getClone

@Nonnull
public PSSpan getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<PSSpan>

toString

public String toString()

Overrides:

toString in class Object