com.helger.schematron.pure.exchange

Class PSReader

java.lang.Object

com.helger.schematron.pure.exchange.PSReader

@Immutable
public class PSReader
extends Object

Utility class for reading all Schematron elements from a resource.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PSReader(com.helger.commons.io.resource.IReadableResource aResource) Constructor without an error handler
PSReader(com.helger.commons.io.resource.IReadableResource aResource, IPSErrorHandler aErrorHandler) Constructor with an error handler

Method Summary

Methods

Modifier and Type	Method and Description
IPSErrorHandler	getErrorHandler()
com.helger.commons.io.resource.IReadableResource	getResource()
PSActive	readActiveFromXML(com.helger.commons.microdom.IMicroElement eActive) Read an <active> element
PSAssertReport	readAssertReportFromXML(com.helger.commons.microdom.IMicroElement eAssertReport) Read an <assert> or a <report> element
PSDiagnostic	readDiagnosticFromXML(com.helger.commons.microdom.IMicroElement eDiagnostic) Read a <diagnostic> element
PSDiagnostics	readDiagnosticsFromXML(com.helger.commons.microdom.IMicroElement eDiagnostics) Read a <diagnostics> element
PSDir	readDirFromXML(com.helger.commons.microdom.IMicroElement eDir) Read a <dir> element
PSEmph	readEmphFromXML(com.helger.commons.microdom.IMicroElement eEmph) Read an <emph> element
PSExtends	readExtendsFromXML(com.helger.commons.microdom.IMicroElement eExtends) Read an <extends> element
PSInclude	readIncludeFromXML(com.helger.commons.microdom.IMicroElement eInclude) Read an <include> element
PSLet	readLetFromXML(com.helger.commons.microdom.IMicroElement eLet) Read a <let> element
PSLinkableGroup	readLinkableGroupFromXML(Map<com.helger.commons.microdom.IMicroQName,String> aAttrs) Read all attributes for a linkable group
PSName	readNameFromXML(com.helger.commons.microdom.IMicroElement eName) Read a <name> element
PSNS	readNSFromXML(com.helger.commons.microdom.IMicroElement eNS) Read a <ns> element
PSParam	readParamFromXML(com.helger.commons.microdom.IMicroElement eParam) Read a <param> element
PSPattern	readPatternFromXML(com.helger.commons.microdom.IMicroElement ePattern) Read a <pattern> element
PSP	readPFromXML(com.helger.commons.microdom.IMicroElement eP) Read a <p> element
PSPhase	readPhaseFromXML(com.helger.commons.microdom.IMicroElement ePhase) Read a <phase> element
PSRichGroup	readRichGroupFromXML(Map<com.helger.commons.microdom.IMicroQName,String> aAttrs) Read all attributes that make up a rich group
PSRule	readRuleFromXML(com.helger.commons.microdom.IMicroElement eRule) Read a <rule> element
PSSchema	readSchema() Read the schema from the resource supplied in the constructor.
PSSchema	readSchemaFromXML(com.helger.commons.microdom.IMicroElement eSchema) Parse the Schematron into a pure Java object.
PSSpan	readSpanFromXML(com.helger.commons.microdom.IMicroElement eSpan) Read a <span> element
PSTitle	readTitleFromXML(com.helger.commons.microdom.IMicroElement eTitle) Read a <title> element
PSValueOf	readValueOfFromXML(com.helger.commons.microdom.IMicroElement eValueOf) Read a <value-of> element
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PSReader

public PSReader(@Nonnull
        com.helger.commons.io.resource.IReadableResource aResource)

Constructor without an error handler

Parameters:

aResource - The resource to read the Schematron from. May not be null.

PSReader

public PSReader(@Nonnull
        com.helger.commons.io.resource.IReadableResource aResource,
        @Nullable
        IPSErrorHandler aErrorHandler)

Constructor with an error handler

Parameters:

aResource - The resource to read the Schematron from. May not be null.

aErrorHandler - The error handler to use. May be null. If the error handler is null a LoggingPSErrorHandler is automatically created and used.

Method Detail

getResource

@Nonnull
public com.helger.commons.io.resource.IReadableResource getResource()

Returns:

The resource from which the Schematron schema is read. Never null.

getErrorHandler

@Nonnull
public IPSErrorHandler getErrorHandler()

Returns:

The error handler used. If no error handler was passed in the constructor, than a LoggingPSErrorHandler is automatically used.

readActiveFromXML

@Nonnull
public PSActive readActiveFromXML(@Nonnull
                                 com.helger.commons.microdom.IMicroElement eActive)

Read an <active> element

Parameters:

eActive - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readAssertReportFromXML

@Nonnull
public PSAssertReport readAssertReportFromXML(@Nonnull
                                             com.helger.commons.microdom.IMicroElement eAssertReport)

Read an <assert> or a <report> element

Parameters:

eAssertReport - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readDiagnosticFromXML

@Nonnull
public PSDiagnostic readDiagnosticFromXML(@Nonnull
                                         com.helger.commons.microdom.IMicroElement eDiagnostic)

Read a <diagnostic> element

Parameters:

eDiagnostic - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readDiagnosticsFromXML

@Nonnull
public PSDiagnostics readDiagnosticsFromXML(@Nonnull
                                           com.helger.commons.microdom.IMicroElement eDiagnostics)

Read a <diagnostics> element

Parameters:

eDiagnostics - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readDirFromXML

@Nonnull
public PSDir readDirFromXML(@Nonnull
                           com.helger.commons.microdom.IMicroElement eDir)

Read a <dir> element

Parameters:

eDir - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readEmphFromXML

@Nonnull
public PSEmph readEmphFromXML(@Nonnull
                             com.helger.commons.microdom.IMicroElement eEmph)

Read an <emph> element

Parameters:

eEmph - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readExtendsFromXML

@Nonnull
public PSExtends readExtendsFromXML(@Nonnull
                                   com.helger.commons.microdom.IMicroElement eExtends)

Read an <extends> element

Parameters:

eExtends - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readIncludeFromXML

@Nonnull
public PSInclude readIncludeFromXML(@Nonnull
                                   com.helger.commons.microdom.IMicroElement eInclude)

Read an <include> element

Parameters:

eInclude - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readLetFromXML

@Nonnull
public PSLet readLetFromXML(@Nonnull
                           com.helger.commons.microdom.IMicroElement eLet)

Read a <let> element

Parameters:

eLet - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readLinkableGroupFromXML

@Nonnull
public PSLinkableGroup readLinkableGroupFromXML(@Nullable
                                               Map<com.helger.commons.microdom.IMicroQName,String> aAttrs)

Read all attributes for a linkable group

Parameters:

aAttrs - The attributes of a micro element. May be null.

Returns:

The created domain object. May not be null.

readNameFromXML

@Nonnull
public PSName readNameFromXML(@Nonnull
                             com.helger.commons.microdom.IMicroElement eName)

Read a <name> element

Parameters:

eName - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readNSFromXML

@Nonnull
public PSNS readNSFromXML(@Nonnull
                         com.helger.commons.microdom.IMicroElement eNS)

Read a <ns> element

Parameters:

eNS - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readPFromXML

@Nonnull
public PSP readPFromXML(@Nonnull
                       com.helger.commons.microdom.IMicroElement eP)

Read a <p> element

Parameters:

eP - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readParamFromXML

@Nonnull
public PSParam readParamFromXML(@Nonnull
                               com.helger.commons.microdom.IMicroElement eParam)

Read a <param> element

Parameters:

eParam - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readPatternFromXML

@Nonnull
public PSPattern readPatternFromXML(@Nonnull
                                   com.helger.commons.microdom.IMicroElement ePattern)

Read a <pattern> element

Parameters:

ePattern - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readPhaseFromXML

@Nonnull
public PSPhase readPhaseFromXML(@Nonnull
                               com.helger.commons.microdom.IMicroElement ePhase)

Read a <phase> element

Parameters:

ePhase - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readRichGroupFromXML

@Nonnull
public PSRichGroup readRichGroupFromXML(@Nullable
                                       Map<com.helger.commons.microdom.IMicroQName,String> aAttrs)

Read all attributes that make up a rich group

Parameters:

aAttrs - The attributes of a micro element. May be null.

Returns:

The created domain object. May not be null.

readRuleFromXML

@Nonnull
public PSRule readRuleFromXML(@Nonnull
                             com.helger.commons.microdom.IMicroElement eRule)

Read a <rule> element

Parameters:

eRule - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readSchemaFromXML

@Nonnull
public PSSchema readSchemaFromXML(@Nonnull
                                 com.helger.commons.microdom.IMicroElement eSchema)
                           throws SchematronReadException

Parse the Schematron into a pure Java object. This method makes no assumptions on the validity of the document!

Parameters:

eSchema - The XML element to use. May not be null.

Returns:

The created PSSchema object or null in case of null document or a fatal error.

Throws:

SchematronReadException - If reading fails

readSpanFromXML

@Nonnull
public PSSpan readSpanFromXML(@Nonnull
                             com.helger.commons.microdom.IMicroElement eSpan)

Read a <span> element

Parameters:

eSpan - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readTitleFromXML

@Nonnull
public PSTitle readTitleFromXML(@Nonnull
                               com.helger.commons.microdom.IMicroElement eTitle)

Read a <title> element

Parameters:

eTitle - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readValueOfFromXML

@Nonnull
public PSValueOf readValueOfFromXML(@Nonnull
                                   com.helger.commons.microdom.IMicroElement eValueOf)

Read a <value-of> element

Parameters:

eValueOf - The source micro element. Never null.

Returns:

The created domain object. May not be null.

readSchema

@Nonnull
public PSSchema readSchema()
                    throws SchematronReadException

Read the schema from the resource supplied in the constructor. First all includes are resolved and the readSchemaFromXML(IMicroElement) is called.

Returns:

The read PSSchema.

Throws:

SchematronReadException - If reading fails

toString

public String toString()

Overrides:

toString in class Object