Package com.helger.schematron.pure.model

Class PSDiagnostics

java.lang.Object

com.helger.schematron.pure.model.PSDiagnostics

All Implemented Interfaces:

IPSElement, IPSHasForeignAttributes, IPSHasForeignElements, IPSHasIncludes, IPSOptionalElement

@NotThreadSafe
public class PSDiagnostics
extends Object
implements IPSElement, IPSOptionalElement, IPSHasForeignElements, IPSHasIncludes

A single Schematron diagnostics-element.
A section containing individual diagnostic elements.
An implementation is not required to make use of this element.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
PSDiagnostics()

Method Summary

Modifier and Type	Method	Description
void	addDiagnostic(PSDiagnostic aDiagnostic)
void	addForeignAttribute(String sAttrName, String sAttrValue)
void	addForeignElement(com.helger.xml.microdom.IMicroElement aForeignElement)
void	addInclude(PSInclude aInclude)	Add an include to this object.
com.helger.commons.collection.impl.ICommonsList<PSDiagnostic>	getAllDiagnostics()
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAllForeignAttributes()
com.helger.commons.collection.impl.ICommonsList<com.helger.xml.microdom.IMicroElement>	getAllForeignElements()
com.helger.commons.collection.impl.ICommonsList<PSInclude>	getAllIncludes()
com.helger.xml.microdom.IMicroElement	getAsMicroElement()
PSDiagnostic	getDiagnosticOfID(String sID)
boolean	hasAnyInclude()
boolean	hasForeignAttributes()
boolean	hasForeignElements()
boolean	isMinimal()
boolean	isValid(IPSErrorHandler aErrorHandler)	Check if this element is specified completely.
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.IPSHasForeignAttributes

addForeignAttributes

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

addForeignElements

Constructor Details

PSDiagnostics

public PSDiagnostics()

Method Details

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.impl.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.impl.ICommonsOrderedMap<String,String> getAllForeignAttributes()

Specified by:

getAllForeignAttributes in interface IPSHasForeignAttributes

addInclude

public void addInclude(@Nonnull
 PSInclude aInclude)

Description copied from interface: IPSHasIncludes

Add an include to this object.

Specified by:

addInclude in interface IPSHasIncludes

Parameters:

aInclude - The include to be added. May not be null.

hasAnyInclude

public boolean hasAnyInclude()

Specified by:

hasAnyInclude in interface IPSHasIncludes

Returns:

true if at least one include is present in this object.

getAllIncludes

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<PSInclude> getAllIncludes()

Specified by:

getAllIncludes in interface IPSHasIncludes

Returns:

A list of all contained includes. Never null.

addDiagnostic

public void addDiagnostic(@Nonnull
 PSDiagnostic aDiagnostic)

getDiagnosticOfID

@Nullable
public PSDiagnostic getDiagnosticOfID(@Nullable
 String sID)

getAllDiagnostics

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<PSDiagnostic> getAllDiagnostics()

getAsMicroElement

@Nonnull
public com.helger.xml.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