org.plasma.sdo.helper

Class PlasmaXSDHelper

java.lang.Object

org.plasma.sdo.helper.PlasmaXSDHelper

All Implemented Interfaces:

commonj.sdo.helper.XSDHelper

public class PlasmaXSDHelper
extends Object
implements commonj.sdo.helper.XSDHelper

Field Summary

Fields

Modifier and Type	Field and Description
static PlasmaXSDHelper	INSTANCE

Method Summary

Modifier and Type	Method and Description
List<commonj.sdo.Type>	define(InputStream xsdInputStream, String schemaLocation) Define XML Schema as Types.
List<commonj.sdo.Type>	define(Reader xsdReader, String schemaLocation) Define XML Schema as Types.
List<commonj.sdo.Type>	define(String xsd) Define the XML Schema as Types.
String	generate(List<commonj.sdo.Type> types) Generate an XML Schema Declaration (XSD) from Types.
String	generate(List<commonj.sdo.Type> types, Map<String,String> namespaceToSchemaLocation) Generate an XML Schema Declaration (XSD) from Types.
String	generate(Query query, String targetNamespaceURI, String targetNamespacePrefix, Map<String,String> namespaceToSchemaLocation) Generate an XML Schema Declaration (XSD) with dynamically determined containment references as embodied within the given, PlasmaQueryTM, query.
void	generate(Query query, String targetNamespaceURI, String targetNamespacePrefix, Map<String,String> namespaceToSchemaLocation, OutputStream xsdOutputStream)
String	getAppinfo(commonj.sdo.Property property, String source)
String	getAppinfo(commonj.sdo.Type type, String source)
commonj.sdo.Property	getGlobalProperty(String uri, String propertyName, boolean isElement)
String	getLocalName(commonj.sdo.Property property)
String	getLocalName(commonj.sdo.Type type)
String	getNamespaceURI(commonj.sdo.Property property)
boolean	isAttribute(commonj.sdo.Property property)
boolean	isElement(commonj.sdo.Property property)
boolean	isMixed(commonj.sdo.Type type)
boolean	isXSD(commonj.sdo.Type type)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static volatile PlasmaXSDHelper INSTANCE

Method Detail

define

public List<commonj.sdo.Type> define(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 commonj.sdo.helper.XSDHelper

Parameters:

xsd - the XML Schema.

Returns:

the defined Types.

Throws:

IllegalArgumentException - if the Types could not be defined.

define

public List<commonj.sdo.Type> define(Reader xsdReader,
                                     String schemaLocation)

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

Specified by:

define in interface commonj.sdo.helper.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:

IllegalArgumentException - if the Types could not be defined.

define

public List<commonj.sdo.Type> define(InputStream xsdInputStream,
                                     String schemaLocation)

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

Specified by:

define in interface commonj.sdo.helper.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:

IllegalArgumentException - if the Types could not be defined.

generate

public String generate(List<commonj.sdo.Type> types)

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

Specified by:

generate in interface commonj.sdo.helper.XSDHelper

Parameters:

types - a List containing the Types

Returns:

a String containing the generated XSD.

Throws:

IllegalArgumentException - if the XSD could not be generated.

generate

public String generate(List<commonj.sdo.Type> types,
                       Map<String,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 commonj.sdo.helper.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:

IllegalArgumentException - if the XSD could not be generated.

generate

public String generate(Query query,
                       String targetNamespaceURI,
                       String targetNamespacePrefix,
                       Map<String,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:

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,
                     String targetNamespaceURI,
                     String targetNamespacePrefix,
                     Map<String,String> namespaceToSchemaLocation,
                     OutputStream xsdOutputStream)

getAppinfo

public String getAppinfo(commonj.sdo.Type type,
                         String source)

Specified by:

getAppinfo in interface commonj.sdo.helper.XSDHelper

getAppinfo

public String getAppinfo(commonj.sdo.Property property,
                         String source)

Specified by:

getAppinfo in interface commonj.sdo.helper.XSDHelper

getGlobalProperty

public commonj.sdo.Property getGlobalProperty(String uri,
                                              String propertyName,
                                              boolean isElement)

Specified by:

getGlobalProperty in interface commonj.sdo.helper.XSDHelper

getLocalName

public String getLocalName(commonj.sdo.Type type)

Specified by:

getLocalName in interface commonj.sdo.helper.XSDHelper

getLocalName

public String getLocalName(commonj.sdo.Property property)

Specified by:

getLocalName in interface commonj.sdo.helper.XSDHelper

getNamespaceURI

public String getNamespaceURI(commonj.sdo.Property property)

Specified by:

getNamespaceURI in interface commonj.sdo.helper.XSDHelper

isAttribute

public boolean isAttribute(commonj.sdo.Property property)

Specified by:

isAttribute in interface commonj.sdo.helper.XSDHelper

isElement

public boolean isElement(commonj.sdo.Property property)

Specified by:

isElement in interface commonj.sdo.helper.XSDHelper

isMixed

public boolean isMixed(commonj.sdo.Type type)

Specified by:

isMixed in interface commonj.sdo.helper.XSDHelper

isXSD

public boolean isXSD(commonj.sdo.Type type)

Specified by:

isXSD in interface commonj.sdo.helper.XSDHelper