com.helger.ubl

Interface IUBLDocumentType

All Superinterfaces:

com.helger.commons.xml.schema.IHasSchema, Serializable

All Known Implementing Classes:

EUBL20DocumentType, EUBL21DocumentType

public interface IUBLDocumentType
extends com.helger.commons.xml.schema.IHasSchema, Serializable

Base interface describing a single UBL document type, independent of the version.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	getImplementationClass()
String	getLocalName()
String	getNamespaceURI()
Package	getPackage()
QName	getQName()
Schema	getSchema()
Validator	getValidator()
String	getXSDPath()
com.helger.commons.io.IReadableResource	getXSDResource()
com.helger.commons.error.IResourceErrorGroup	validateXML(com.helger.commons.io.IReadableResource aXML) Validate the passed XML instance against the XML Schema of this document type.

Method Detail

getImplementationClass

@Nonnull
Class<?> getImplementationClass()

Returns:

The class implementing this document type. Never null.

getPackage

@Nonnull
Package getPackage()

Returns:

The package of the implementation class. Never null.

getLocalName

@Nonnull
String getLocalName()

Returns:

The local name of the root element of an XML document of this type. Corresponds to the name of the implementation class (without a package).

getNamespaceURI

@Nonnull
String getNamespaceURI()

Returns:

The non-null XML namespace of this UBL document type.

getQName

@Nonnull
QName getQName()

Returns:

The combination of local name and namespace URI matching this document type. Never null.

getXSDPath

@Nonnull
String getXSDPath()

Returns:

The path within the classpath where the main XSD file resides.

getXSDResource

@Nonnull
com.helger.commons.io.IReadableResource getXSDResource()

Returns:

The resource from which the XSD can be read.

getSchema

@Nonnull
Schema getSchema()

Specified by:

getSchema in interface com.helger.commons.xml.schema.IHasSchema

Returns:

The non-null compiled Schema object retrieved by the XMLSchemaCache.

getValidator

@Nonnull
Validator getValidator()

Returns:

The non-null compiled Validator object retrieved from the schema to be obtained from getSchema().

validateXML

@Nonnull
com.helger.commons.error.IResourceErrorGroup validateXML(@Nonnull
                                                               com.helger.commons.io.IReadableResource aXML)

Validate the passed XML instance against the XML Schema of this document type.

Parameters:

aXML - The XML resource to be validated.

Returns:

A non-null group of validation errors. Is empty if no error occurred.