com.phloc.schematron.pure.model

Class PSAssertReport

java.lang.Object

com.phloc.schematron.pure.model.PSAssertReport

All Implemented Interfaces:

IPSElement, IPSHasFlag, IPSHasForeignAttributes, IPSHasForeignElements, IPSHasID, IPSHasLinkableGroup, IPSHasMixedContent, IPSHasRichGroup, IPSHasTexts, Serializable

@NotThreadSafe
public class PSAssertReport
extends Object
implements IPSElement, IPSHasFlag, IPSHasForeignElements, IPSHasMixedContent, IPSHasID, IPSHasRichGroup, IPSHasLinkableGroup

A single Schematron assert- or report-element.
An assertion made about the context nodes. The data content is a natural-language assertion. The required test attribute is an assertion test evaluated in the current context. If the test evaluates positive, the assertion succeeds. The optional diagnostics attribute is a reference to further diagnostic information.
The natural-language assertion shall be a positive statement of a constraint. NOTE: The natural-language assertion may contain information about actual values in addition to expected values and may contain diagnostic information. Users should note, however, that the diagnostic element is provided for such information to encourage clear statement of the natural-language assertion.
The icon, see and fpi attributes allow rich interfaces and documentation.
The flag attribute allows more detailed outcomes.
The role and subject attributes allow explicit identification of some part of a pattern.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PSAssertReport(boolean bIsAssert)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDir(PSDir aDir)
void	addEmph(PSEmph aEmph)
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	addName(PSName aName)
void	addSpan(PSSpan aSpan)
void	addText(String sText) Add a new text element.
void	addValueOf(PSValueOf aValueOf)
List<Object>	getAllContentElements()
List<String>	getAllDiagnostics()
List<PSDir>	getAllDirs()
List<PSEmph>	getAllEmphs()
Map<String,String>	getAllForeignAttributes()
List<com.phloc.commons.microdom.IMicroElement>	getAllForeignElements()
List<PSName>	getAllNames()
List<PSSpan>	getAllSpans()
List<String>	getAllTexts()
List<PSValueOf>	getAllValueOfs()
com.phloc.commons.microdom.IMicroElement	getAsMicroElement()
String	getFlag() The name of a Boolean flag variable.
String	getID()
PSLinkableGroup	getLinkable()
PSLinkableGroup	getLinkableClone()
PSRichGroup	getRich()
PSRichGroup	getRichClone()
String	getTest()
boolean	hasAnyText()
boolean	hasForeignAttributes()
boolean	hasForeignElements()
boolean	hasID()
boolean	hasLinkable()
boolean	hasRich()
boolean	isAssert()
boolean	isMinimal()
boolean	isReport()
boolean	isValid(com.phloc.commons.log.InMemoryLogger aLogger)
void	setDiagnostics(List<String> aDiagnostics) Set the diagnostics, as an IDREFS value (multiple IDREF values separated by spaces)
void	setDiagnostics(String sDiagnostics) Set the diagnostics, as an IDREFS value (multiple IDREF values separated by spaces)
void	setFlag(String sFlag)
void	setID(String sID) Set an ID for this object.
void	setLinkable(PSLinkableGroup aLinkable) Overwrite any existing linkable group.
void	setRich(PSRichGroup aRich) Overwrite any existing rich group.
void	setTest(String sTest)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PSAssertReport

public PSAssertReport(boolean bIsAssert)

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

isAssert

public boolean isAssert()

isReport

public boolean isReport()

setTest

public void setTest(@Nullable
           String sTest)

getTest

@Nullable
public String getTest()

setFlag

public void setFlag(@Nullable
           String sFlag)

getFlag

@Nullable
public String getFlag()

Description copied from interface: IPSHasFlag

The name of a Boolean flag variable. A flag is implicitly declared by an assertion or rule having a flag attribute with that name. The value of a flag becomes true when an assertion with that flag fails or a rule with that flag fires.
The purpose of flags is to convey state or severity information to a subsequent process.
An implementation is not required to make use of this attribute.

Specified by:

getFlag in interface IPSHasFlag

Returns:

The flag value

setID

public void setID(@Nullable
         String sID)

Description copied from interface: IPSHasID

Set an ID for this object.

Specified by:

setID in interface IPSHasID

Parameters:

sID - The ID to be set. May be null.

hasID

public boolean hasID()

Specified by:

hasID in interface IPSHasID

Returns:

true if an ID is present, false otherwise.

getID

@Nullable
public String getID()

Specified by:

getID in interface IPSHasID

Returns:

The optional ID of this element. May be null.

setDiagnostics

public void setDiagnostics(@Nullable
                  String sDiagnostics)

Set the diagnostics, as an IDREFS value (multiple IDREF values separated by spaces)

Parameters:

sDiagnostics - The value to be set. May be null.

setDiagnostics

public void setDiagnostics(@Nullable
                  List<String> aDiagnostics)

Set the diagnostics, as an IDREFS value (multiple IDREF values separated by spaces)

Parameters:

aDiagnostics - The value to be set. May be null.

getAllDiagnostics

@Nonnull
@ReturnsMutableCopy
public List<String> getAllDiagnostics()

Returns:

List of references to PSDiagnostic elements.

setRich

public void setRich(@Nullable
           PSRichGroup aRich)

Description copied from interface: IPSHasRichGroup

Overwrite any existing rich group.

Specified by:

setRich in interface IPSHasRichGroup

Parameters:

aRich - The new rich group to set. May be null.

hasRich

public boolean hasRich()

Specified by:

hasRich in interface IPSHasRichGroup

Returns:

true if a rich group is present, false otherwise.

getRich

@Nullable
public PSRichGroup getRich()

Specified by:

getRich in interface IPSHasRichGroup

Returns:

Get the existing rich group or null if none is present.

getRichClone

@Nullable
public PSRichGroup getRichClone()

Specified by:

getRichClone in interface IPSHasRichGroup

Returns:

Get a clone of the rich group or null if no rich group is present at this object.

setLinkable

public void setLinkable(@Nullable
               PSLinkableGroup aLinkable)

Description copied from interface: IPSHasLinkableGroup

Overwrite any existing linkable group.

Specified by:

setLinkable in interface IPSHasLinkableGroup

Parameters:

aLinkable - The new linkable group to set. May be null.

hasLinkable

public boolean hasLinkable()

Specified by:

hasLinkable in interface IPSHasLinkableGroup

Returns:

true if a linkable group is present, false otherwise.

getLinkable

@Nullable
public PSLinkableGroup getLinkable()

Specified by:

getLinkable in interface IPSHasLinkableGroup

Returns:

Get the existing linkable group or null if none is present.

getLinkableClone

@Nullable
public PSLinkableGroup getLinkableClone()

Specified by:

getLinkableClone in interface IPSHasLinkableGroup

Returns:

Get a clone of the linkable group or null if no linkable group is present at this object.

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.

addName

public void addName(@Nonnull
           PSName aName)

getAllNames

@Nonnull
@ReturnsMutableCopy
public List<PSName> getAllNames()

addValueOf

public void addValueOf(@Nonnull
              PSValueOf aValueOf)

getAllValueOfs

@Nonnull
@ReturnsMutableCopy
public List<PSValueOf> getAllValueOfs()

addEmph

public void addEmph(@Nonnull
           PSEmph aEmph)

getAllEmphs

@Nonnull
@ReturnsMutableCopy
public List<PSEmph> getAllEmphs()

addDir

public void addDir(@Nonnull
          PSDir aDir)

getAllDirs

@Nonnull
@ReturnsMutableCopy
public List<PSDir> getAllDirs()

addSpan

public void addSpan(@Nonnull
           PSSpan aSpan)

getAllSpans

@Nonnull
@ReturnsMutableCopy
public List<PSSpan> getAllSpans()

getAllContentElements

@Nonnull
@ReturnsMutableCopy
public List<Object> getAllContentElements()

Specified by:

getAllContentElements in interface IPSHasMixedContent

Returns:

A list of String, PSName, PSValueOf, PSEmph, PSDir and PSSpan elements.

getAsMicroElement

@Nonnull
public com.phloc.commons.microdom.IMicroElement getAsMicroElement()

Specified by:

getAsMicroElement in interface IPSElement

Returns:

The XML representation of this element. Never null.

toString

public String toString()

Overrides:

toString in class Object