com.ebm_ws.infra.xmlmapping.schema
Interface ISchema

All Known Implementing Classes:

SchemaImpl

public interface ISchema

Represents relationships between all classes that conform to implicit Xml Mapping rule in a given root package.
A bunch of objects that take advantage of implicit Xml Mappings should be organized within a schema.
Basically this is just sharing a root java package.

Method Summary

void	buildFromClassPath() Builds the schema (i.e. looks for all elements) by searching the classpath for classes.
void	buildFromSource(java.lang.String iSourceDir) Builds the schema (i.e. looks for all elements) by searching the given source directory.
void	buildFromXsd(org.w3c.dom.Document iXsdDoc) Builds the schema (i.e. looks for all elements) by parsing the XSD file.
void	buildFromXsd(java.io.InputStream iInput) Builds the schema (i.e. looks for all elements) by parsing the XSD file.
void	generateXSD(org.w3c.dom.Document iXmlDoc) Generates the XSD structure for this schema.
ISchemaElement[]	getAllElements() Returns all elements belonging to this schema.
ISchemaElement	getElement(java.lang.Class iClass)
java.lang.String	getLocator() Returns the schema location (this is the xsd file).
java.lang.String	getName() Returns the schema name (that is also the prefix).
java.lang.String	getRootPackage() Returns the schema root package (that is also the schema namespace)
ISchema[]	getUsedSchemas() Returns a list of schemas referenced by this schema.
boolean	isFullyBuilt() Determines whether this schema has been loaded.

Method Detail

getName

java.lang.String getName()

Returns the schema name (that is also the prefix).

getLocator

java.lang.String getLocator()

Returns the schema location (this is the xsd file).

getRootPackage

java.lang.String getRootPackage()

Returns the schema root package (that is also the schema namespace)

getUsedSchemas

ISchema[] getUsedSchemas()

Returns a list of schemas referenced by this schema.

Returns:

getAllElements

ISchemaElement[] getAllElements()

Returns all elements belonging to this schema.

Returns:

buildFromClassPath

void buildFromClassPath()
                        throws java.lang.Exception

Builds the schema (i.e. looks for all elements) by searching the classpath for classes.

Throws:

java.lang.Exception

buildFromSource

void buildFromSource(java.lang.String iSourceDir)
                     throws java.lang.Exception

Builds the schema (i.e. looks for all elements) by searching the given source directory.

Throws:

java.lang.Exception

buildFromXsd

void buildFromXsd(org.w3c.dom.Document iXsdDoc)
                  throws java.lang.Exception

Builds the schema (i.e. looks for all elements) by parsing the XSD file.

Throws:

java.lang.Exception

buildFromXsd

void buildFromXsd(java.io.InputStream iInput)
                  throws java.lang.Exception

Builds the schema (i.e. looks for all elements) by parsing the XSD file.

Throws:

java.lang.Exception

isFullyBuilt

boolean isFullyBuilt()

Determines whether this schema has been loaded.

Returns:

generateXSD

void generateXSD(org.w3c.dom.Document iXmlDoc)

Generates the XSD structure for this schema.

Parameters:

iXmlDoc -

getElement

ISchemaElement getElement(java.lang.Class iClass)