com.phloc.schematron.pure.model

Class PSDir

java.lang.Object

com.phloc.schematron.pure.model.PSDir

All Implemented Interfaces:

com.phloc.commons.ICloneable<PSDir>, IPSClonableElement<PSDir>, IPSElement, IPSHasForeignAttributes, IPSHasForeignElements, IPSHasTexts, IPSOptionalElement, Serializable

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

A single Schematron dir-element.
A section of natural-language text with a direction specified by the value attribute. The value ltr indicates left-to-right text; the value rtl indicates right-to-left text.
An implementation is not required to make use of this element.

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PSDir.EDirValue

Constructor Summary

Constructors

Constructor and Description
PSDir()

Method Summary

Methods

Modifier and Type	Method and Description
void	addForeignAttribute(String sAttrName, String sAttrValue)
void	addForeignAttributes(Map<String,String> aForeignAttrs)
void	addForeignElement(com.phloc.commons.microdom.IMicroElement aForeignElement)
void	addForeignElements(List<com.phloc.commons.microdom.IMicroElement> aForeignElements)
void	addText(String sText) Add a new text element.
Map<String,String>	getAllForeignAttributes()
List<com.phloc.commons.microdom.IMicroElement>	getAllForeignElements()
List<String>	getAllTexts()
com.phloc.commons.microdom.IMicroElement	getAsMicroElement()
String	getAsText()
PSDir	getClone()
PSDir.EDirValue	getValue()
boolean	hasAnyText()
boolean	hasForeignAttributes()
boolean	hasForeignElements()
boolean	isMinimal()
boolean	isValid(com.phloc.commons.log.InMemoryLogger aLogger)
void	setValue(PSDir.EDirValue eValue)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PSDir

public PSDir()

Method Detail

isValid

public boolean isValid(@Nonnull
              com.phloc.commons.log.InMemoryLogger aLogger)

Specified by:

isValid in interface IPSElement

Parameters:

aLogger - The logger 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.

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.phloc.commons.microdom.IMicroElement aForeignElement)

Specified by:

addForeignElement in interface IPSHasForeignElements

addForeignElements

public void addForeignElements(@Nonnull
                      List<com.phloc.commons.microdom.IMicroElement> aForeignElements)

Specified by:

addForeignElements in interface IPSHasForeignElements

hasForeignElements

public boolean hasForeignElements()

Specified by:

hasForeignElements in interface IPSHasForeignElements

getAllForeignElements

@Nonnull
@ReturnsMutableCopy
public List<com.phloc.commons.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

addForeignAttributes

public void addForeignAttributes(@Nonnull
                        Map<String,String> aForeignAttrs)

Specified by:

addForeignAttributes in interface IPSHasForeignAttributes

hasForeignAttributes

public boolean hasForeignAttributes()

Specified by:

hasForeignAttributes in interface IPSHasForeignAttributes

getAllForeignAttributes

@Nonnull
@ReturnsMutableCopy
public Map<String,String> getAllForeignAttributes()

Specified by:

getAllForeignAttributes in interface IPSHasForeignAttributes

setValue

public void setValue(@Nullable
            PSDir.EDirValue eValue)

getValue

@Nullable
public PSDir.EDirValue getValue()

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 List<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.phloc.commons.microdom.IMicroElement getAsMicroElement()

Specified by:

getAsMicroElement in interface IPSElement

Returns:

The XML representation of this element. Never null.

getClone

@Nonnull
public PSDir getClone()

Specified by:

getClone in interface com.phloc.commons.ICloneable<PSDir>

toString

public String toString()

Overrides:

toString in class Object