com.helger.ubl21

Class UBL21DocumentTypes

java.lang.Object

com.helger.ubl21.UBL21DocumentTypes

@Immutable
public final class UBL21DocumentTypes
extends Object

UBL document type map. Provides sanity methods for accessing UBL 2.1 document types based on different information items.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static com.helger.commons.collection.impl.ICommonsSet<String>	getAllLocalNames()
static com.helger.commons.collection.impl.ICommonsSet<String>	getAllNamespaces()
static EUBL21DocumentType	getDocumentTypeOfImplementationClass(Class<?> aImplClass) Get the UBL 2.1 document type matching the passed implementation class.
static EUBL21DocumentType	getDocumentTypeOfLocalName(String sLocalName) Get the document type matching the passed document element local name.
static EUBL21DocumentType	getDocumentTypeOfNamespace(String sNamespace) Get the document type matching the passed namespace.
static Class<?>	getImplementationClassOfLocalName(String sLocalName) Get the domain object class of the passed document element local name.
static Class<?>	getImplementationClassOfNamespace(String sNamespace) Get the domain object class of the passed namespace.
static Schema	getSchemaOfImplementationClass(Class<?> aImplClass) Get the XSD Schema object for the UBL 2.1 document type of the passed implementation class.
static Schema	getSchemaOfLocalName(String sLocalName) Get the XSD Schema object for the UBL 2.1 document type of the passed document element local name.
static Schema	getSchemaOfNamespace(String sNamespace) Get the XSD Schema object for the UBL 2.1 document type of the passed namespace.

Methods inherited from class java.lang.Object

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

Method Detail

getAllNamespaces

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsSet<String> getAllNamespaces()

Returns:

A non-null set of all supported UBL 2.1 namespaces.

getDocumentTypeOfNamespace

@Nullable
public static EUBL21DocumentType getDocumentTypeOfNamespace(@Nullable
                                                                       String sNamespace)

Get the document type matching the passed namespace.

Parameters:

sNamespace - The namespace URI of any UBL 2.1 document type. May be null.

Returns:

null if no UBL 2.1 document type matching the specified namespace URI exists.

getImplementationClassOfNamespace

@Nullable
public static Class<?> getImplementationClassOfNamespace(@Nullable
                                                                    String sNamespace)

Get the domain object class of the passed namespace.

Parameters:

sNamespace - The namespace URI of any UBL 2.1 document type. May be null.

Returns:

null if no such UBL 2.1 document type exists.

getDocumentTypeOfImplementationClass

@Nullable
public static EUBL21DocumentType getDocumentTypeOfImplementationClass(@Nullable
                                                                                 Class<?> aImplClass)

Get the UBL 2.1 document type matching the passed implementation class.

Parameters:

aImplClass - The implementation class to use. May be null.

Returns:

null if the implementation class is null or if no UBL 2.1 document type has the specified implementation class.

getSchemaOfNamespace

@Nullable
public static Schema getSchemaOfNamespace(@Nullable
                                                     String sNamespace)

Get the XSD Schema object for the UBL 2.1 document type of the passed namespace.

Parameters:

sNamespace - The namespace URI of any UBL 2.1 document type. May be null.

Returns:

null if no such UBL 2.1 document type exists.

getAllLocalNames

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsSet<String> getAllLocalNames()

Returns:

A non-null set of all supported UBL 2.1 document element local names.

getDocumentTypeOfLocalName

@Nullable
public static EUBL21DocumentType getDocumentTypeOfLocalName(@Nullable
                                                                       String sLocalName)

Get the document type matching the passed document element local name.

Parameters:

sLocalName - The document element local name of any UBL 2.1 document type. May be null.

Returns:

null if no UBL 2.1 document type matching the specified local name exists.

getImplementationClassOfLocalName

@Nullable
public static Class<?> getImplementationClassOfLocalName(@Nullable
                                                                    String sLocalName)

Get the domain object class of the passed document element local name.

Parameters:

sLocalName - The document element local name of any UBL 2.1 document type. May be null.

Returns:

null if no such implementation class exists.

getSchemaOfLocalName

@Nullable
public static Schema getSchemaOfLocalName(@Nullable
                                                     String sLocalName)

Get the XSD Schema object for the UBL 2.1 document type of the passed document element local name.

Parameters:

sLocalName - The document element local name of any UBL 2.1 document type. May be null.

Returns:

null if no such UBL 2.1 document type exists.

getSchemaOfImplementationClass

@Nullable
public static Schema getSchemaOfImplementationClass(@Nullable
                                                               Class<?> aImplClass)

Get the XSD Schema object for the UBL 2.1 document type of the passed implementation class.

Parameters:

aImplClass - The implementation class of any UBL 2.1 document type. May be null.

Returns:

null if no such UBL 2.1 document type exists.