org.plasma.sdo.helper
Class PlasmaXSDHelper

java.lang.Object
  org.plasma.sdo.helper.PlasmaXSDHelper

All Implemented Interfaces:

XSDHelper

public class PlasmaXSDHelper
extends java.lang.Object
implements XSDHelper

Field Summary

static PlasmaXSDHelper

INSTANCE

Method Summary

java.util.List<Type>	define(java.io.InputStream xsdInputStream, java.lang.String schemaLocation) Define XML Schema as Types.
java.util.List<Type>	define(java.io.Reader xsdReader, java.lang.String schemaLocation) Define XML Schema as Types.
java.util.List<Type>	define(java.lang.String xsd) Define the XML Schema as Types.
java.lang.String	generate(java.util.List<Type> types) Generate an XML Schema Declaration (XSD) from Types.
java.lang.String	generate(java.util.List<Type> types, java.util.Map<java.lang.String,java.lang.String> namespaceToSchemaLocation) Generate an XML Schema Declaration (XSD) from Types.
java.lang.String	generate(Query query, java.lang.String targetNamespaceURI, java.lang.String targetNamespacePrefix, java.util.Map<java.lang.String,java.lang.String> namespaceToSchemaLocation) Generate an XML Schema Declaration (XSD) with dynamically determined containment references as embodied within the given, PlasmaQueryTM, query.
void	generate(Query query, java.lang.String targetNamespaceURI, java.lang.String targetNamespacePrefix, java.util.Map<java.lang.String,java.lang.String> namespaceToSchemaLocation, java.io.OutputStream xsdOutputStream)
java.lang.String	getAppinfo(Property property, java.lang.String source) Return the content of the appinfo declared for this Property and source.
java.lang.String	getAppinfo(Type type, java.lang.String source) Return the appinfo declared for this Type and source.
Property	getGlobalProperty(java.lang.String uri, java.lang.String propertyName, boolean isElement) Returns the Property defined by the named global element or attribute in the targetNamespace uri, or null if not found.
java.lang.String	getLocalName(Property property) Returns the local name as declared in the XSD.
java.lang.String	getLocalName(Type type) Returns the local name as declared in the XSD.
java.lang.String	getNamespaceURI(Property property) Returns the namespace URI as declared in the XSD.
boolean	isAttribute(Property property) Returns true if the property is declared as an attribute in the XSD.
boolean	isElement(Property property) Returns true if the property is declared as an element in the XSD.
boolean	isMixed(Type type) Returns true if the Type is declared to contain mixed content.
boolean	isXSD(Type type) Indicates if this helper contains XSD information for the specified type.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static PlasmaXSDHelper INSTANCE

Method Detail

define

public java.util.List<Type> define(java.lang.String xsd)

Define the XML Schema as Types. The Types are available through TypeHelper and DataGraph getType() methods. Same as define(new StringReader(xsd), null)

Specified by:

define in interface XSDHelper

Parameters:

xsd - the XML Schema.

Returns:

the defined Types.

Throws:

java.lang.IllegalArgumentException - if the Types could not be defined.

define

public java.util.List<Type> define(java.io.Reader xsdReader,
                                   java.lang.String schemaLocation)

Define XML Schema as Types. The Types are available through TypeHelper and DataGraph getType() methods.

Specified by:

define in interface XSDHelper

Parameters:

xsdReader - reader to an XML Schema.

schemaLocation - the URI of the location of the schema, used for processing relative imports and includes. May be null if not used.

Returns:

the defined Types.

Throws:

java.lang.IllegalArgumentException - if the Types could not be defined.

define

public java.util.List<Type> define(java.io.InputStream xsdInputStream,
                                   java.lang.String schemaLocation)

Define XML Schema as Types. The Types are available through TypeHelper and DataGraph getType() methods.

Specified by:

define in interface XSDHelper

Parameters:

xsdInputStream - input stream to an XML Schema.

schemaLocation - the URI of the location of the schema, used for processing relative imports and includes. May be null if not used.

Returns:

the defined Types.

Throws:

java.lang.IllegalArgumentException - if the Types could not be defined.

generate

public java.lang.String generate(java.util.List<Type> types)

Generate an XML Schema Declaration (XSD) from Types. Same as generate(types, null);

Specified by:

generate in interface XSDHelper

Parameters:

types - a List containing the Types

Returns:

a String containing the generated XSD.

Throws:

java.lang.IllegalArgumentException - if the XSD could not be generated.

generate

public java.lang.String generate(java.util.List<Type> types,
                                 java.util.Map<java.lang.String,java.lang.String> namespaceToSchemaLocation)

Generate an XML Schema Declaration (XSD) from Types. Round trip from SDO to XSD to SDO is supported. Round trip from XSD to SDO to XSD is not supported. Use the original schema if one exists instead of generating a new one, as the generated XSD validates a different set of documents than the original XSD. Generating an XSD does not affect the XSDHelper or the Types. The Types must all have the same URI. The result is a String containing the generated XSD. All Types referenced with the same URI will be generated in the XSD and the list will be expanded to include all types generated. Any Types referenced with other URIs will cause imports to be produced as appropriate. Imports will include a schemaLocation if a Map is provided with an entry of the form key=import target namespace, value=schemaLocation

Specified by:

generate in interface XSDHelper

Parameters:

types - a List containing the Types

namespaceToSchemaLocation - map of target namespace to schema locations or null

Returns:

a String containing the generated XSD.

Throws:

java.lang.IllegalArgumentException - if the XSD could not be generated.

generate

public java.lang.String generate(Query query,
                                 java.lang.String targetNamespaceURI,
                                 java.lang.String targetNamespacePrefix,
                                 java.util.Map<java.lang.String,java.lang.String> namespaceToSchemaLocation)

Generate an XML Schema Declaration (XSD) with dynamically determined containment references as embodied within the given, PlasmaQuery^TM, query. Round trip from SDO to XSD to SDO is supported. Round trip from XSD to SDO to XSD is not supported. Generating an XSD does not affect the XSDHelper or the Types. The Types may have different URIs. The result is a String containing the generated XSD. Imports will include a schemaLocation if a Map is provided with an entry of the form key=import target namespace, value=schemaLocation

Parameters:

query - the Query used to determine selected types and properties, their ordering, local names and other information

targetNamespaceURI - the target namespace for the resulting XSD

namespaceToSchemaLocation - map of target namespace to schema locations or null

Returns:

a String containing the generated XSD.

Throws:

java.lang.IllegalArgumentException - if the XSD could not be generated.

See Also:

org.plasma.query.PathNode, org.plasma.query.PathNode#getSelectClause, Select

generate

public void generate(Query query,
                     java.lang.String targetNamespaceURI,
                     java.lang.String targetNamespacePrefix,
                     java.util.Map<java.lang.String,java.lang.String> namespaceToSchemaLocation,
                     java.io.OutputStream xsdOutputStream)

getAppinfo

public java.lang.String getAppinfo(Type type,
                                   java.lang.String source)

Description copied from interface: XSDHelper

Return the appinfo declared for this Type and source. The appinfo start and end tags and content are returned. The xml namespace context is preserved in the appinfo element. If more than one appinfo with the same source is declared on the same Type their contents are concatenated.

Specified by:

getAppinfo in interface XSDHelper

Parameters:

type - the type with the appinfo declaration

source - the source of the appinfo declaration.

Returns:

the appinfo declared for this Type and source.

getAppinfo

public java.lang.String getAppinfo(Property property,
                                   java.lang.String source)

Description copied from interface: XSDHelper

Return the content of the appinfo declared for this Property and source. If the property is defined by ref= the appinfo of the referenced element or attribute is included. The appinfo start and end tags and content are returned. The xml namespace context is preserved in the appinfo element. If more than one appinfo with the same source is declared on the same Type their contents are concatenated.

Specified by:

getAppinfo in interface XSDHelper

Parameters:

property - the Property with the appinfo declaration

source - the source of the appinfo declaration.

Returns:

the appinfo declared for this Property and source.

getGlobalProperty

public Property getGlobalProperty(java.lang.String uri,
                                  java.lang.String propertyName,
                                  boolean isElement)

Description copied from interface: XSDHelper

Returns the Property defined by the named global element or attribute in the targetNamespace uri, or null if not found.

Specified by:

getGlobalProperty in interface XSDHelper

Parameters:

uri - The uri of the targetNamespace.

propertyName - The name of the global property.

isElement - is true for global elements, false for global attributes.

Returns:

the Property defined by the named global element or attribute in the targetNamespace uri, or null if not found.

getLocalName

public java.lang.String getLocalName(Type type)

Description copied from interface: XSDHelper

Returns the local name as declared in the XSD.

Specified by:

getLocalName in interface XSDHelper

Parameters:

type - to return local name for.

Returns:

the local name as declared in the XSD.

getLocalName

public java.lang.String getLocalName(Property property)

Description copied from interface: XSDHelper

Returns the local name as declared in the XSD.

Specified by:

getLocalName in interface XSDHelper

Parameters:

property - to return local name for.

Returns:

the local name as declared in the XSD.

getNamespaceURI

public java.lang.String getNamespaceURI(Property property)

Description copied from interface: XSDHelper

Returns the namespace URI as declared in the XSD.

Specified by:

getNamespaceURI in interface XSDHelper

Parameters:

property - to return namespace URI for.

Returns:

the namespace URI as declared in the XSD.

isAttribute

public boolean isAttribute(Property property)

Description copied from interface: XSDHelper

Returns true if the property is declared as an attribute in the XSD. Returns false if not known or for advanced cases. It is possible for both isAttribute and isElement to return false but they will not both return true.

Specified by:

isAttribute in interface XSDHelper

Parameters:

property - to identify if an attribute.

Returns:

true if the property is declared as an attribute in the XSD.

isElement

public boolean isElement(Property property)

Description copied from interface: XSDHelper

Returns true if the property is declared as an element in the XSD. Returns false if not known or for advanced cases. It is possible for both isAttribute and isElement to return false but they will not both return true.

Specified by:

isElement in interface XSDHelper

Parameters:

property - to identify if an element.

Returns:

true if the property is declared as an element in the XSD.

isMixed

public boolean isMixed(Type type)

Description copied from interface: XSDHelper

Returns true if the Type is declared to contain mixed content. A DataObject's mixed content values are typically accessed via a Sequence.

Specified by:

isMixed in interface XSDHelper

Parameters:

type - to identify if mixed content.

Returns:

true if the Type is declared to contain mixed content.

isXSD

public boolean isXSD(Type type)

Description copied from interface: XSDHelper

Indicates if this helper contains XSD information for the specified type.

Specified by:

isXSD in interface XSDHelper

Parameters:

type - the type.

Returns:

true if this helper contains XSD information for the specified type.