- java.lang.Object
-
- org.eclipse.persistence.sdo.helper.delegates.AbstractHelperDelegator
-
- org.eclipse.persistence.sdo.helper.delegates.SDOXSDHelperDelegator
-
- All Implemented Interfaces:
XSDHelper
,SDOXSDHelper
public class SDOXSDHelperDelegator extends AbstractHelperDelegator implements SDOXSDHelper
Purpose: Provides access to additional information when the Type or Property is defined by an XML Schema (XSD)..
Responsibilities:
- Finds the appropriate SDOXSDHelperDelegate for the classLoader/application name and delegates work to that implementation of SDOXSDHelper.
- Define methods defines Types from an XSD.
- Generate methods an XSD from Types.
- Other Methods return null/false otherwise or if the information is unavailable.
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.sdo.helper.delegates.AbstractHelperDelegator
aHelperContext
-
-
Constructor Summary
Constructors Constructor Description SDOXSDHelperDelegator()
SDOXSDHelperDelegator(HelperContext aContext)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addGlobalProperty(QName qname, Property prop, boolean isElement)
INTERNAL:Map
buildAppInfoMap(List appInfoElements)
INTERNAL:List
define(InputStream xsdInputStream, String schemaLocation)
Define XML Schema as Types.List
define(Reader xsdReader, String schemaLocation)
Define XML Schema as Types.List
define(String xsd)
Define the XML Schema as Types.List
define(Source xsdSource, SchemaResolver schemaResolver)
INTERNAL:String
generate(List types)
Generate an XML Schema Declaration (XSD) from Types.String
generate(List types, Map namespaceToSchemaLocation)
Generate an XML Schema Declaration (XSD) from Types.String
generate(List types, SchemaLocationResolver schemaLocationResolver)
INTERNAL:String
getAppinfo(Property property, String source)
Return the content of the appinfo declared for this Property and source.String
getAppinfo(Type type, String source)
Return the appinfo declared for this Type and source.Property
getGlobalProperty(String uri, String propertyName, boolean isElement)
Returns the Property defined by the named global element or attribute in the targetNamespace uri, or null if not found.Property
getGlobalProperty(QName qname, boolean isElement)
INTERNAL:String
getLocalName(Property property)
Returns the local name as declared in the XSD.String
getLocalName(Type type)
Returns the local name as declared in the XSD.String
getNamespaceURI(Property property)
Returns the namespace URI as declared in the XSD.String
getNamespaceURI(Type type)
Returns the namespace URI as declared in the XSD.SDOXSDHelperDelegate
getXSDHelperDelegate()
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.void
reset()
INTERNAL:-
Methods inherited from class org.eclipse.persistence.sdo.helper.delegates.AbstractHelperDelegator
getHelperContext, setHelperContext
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.eclipse.persistence.sdo.helper.SDOXSDHelper
getHelperContext, setHelperContext
-
-
-
-
Constructor Detail
-
SDOXSDHelperDelegator
public SDOXSDHelperDelegator()
-
SDOXSDHelperDelegator
public SDOXSDHelperDelegator(HelperContext aContext)
-
-
Method Detail
-
getLocalName
public String getLocalName(Type type)
Description copied from interface:XSDHelper
Returns the local name as declared in the XSD.- Specified by:
getLocalName
in interfaceXSDHelper
- Parameters:
type
- to return local name for.- Returns:
- the local name as declared in the XSD. If
type
is one of the predefined SDO types, the result is undefined.
-
getLocalName
public String getLocalName(Property property)
Description copied from interface:XSDHelper
Returns the local name as declared in the XSD.- Specified by:
getLocalName
in interfaceXSDHelper
- Parameters:
property
- to return local name for.- Returns:
- the local name as declared in the XSD.
-
getNamespaceURI
public String getNamespaceURI(Type type)
Description copied from interface:XSDHelper
Returns the namespace URI as declared in the XSD. If the XSD has no namespace URI, then""
is returned.- Specified by:
getNamespaceURI
in interfaceXSDHelper
- Parameters:
type
- to return namespace URI for- Returns:
- the namespace URI as declared in the XSD.
-
getNamespaceURI
public String getNamespaceURI(Property property)
Description copied from interface:XSDHelper
Returns the namespace URI as declared in the XSD. If the XSD has no namespace URI, then""
is returned.- Specified by:
getNamespaceURI
in interfaceXSDHelper
- 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 interfaceXSDHelper
- 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.
-
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.
-
isXSD
public boolean isXSD(Type type)
Description copied from interface:XSDHelper
Indicates if this helper contains XSD information for the specified type.
-
getGlobalProperty
public Property getGlobalProperty(String uri, 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. If the SDO name for a property is different than the XSD name, then only the XSD name is used for the lookup. Passing innull
or""
for theuri
parameter means that an element/attribute defined in a Schema with no target namespace will be returned.- Specified by:
getGlobalProperty
in interfaceXSDHelper
- 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.
-
getGlobalProperty
public Property getGlobalProperty(QName qname, boolean isElement)
Description copied from interface:SDOXSDHelper
INTERNAL:- Specified by:
getGlobalProperty
in interfaceSDOXSDHelper
- Returns:
-
getAppinfo
public String getAppinfo(Type type, 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 interfaceXSDHelper
- Parameters:
type
- the type with the appinfo declarationsource
- the source of the appinfo declaration.- Returns:
- the appinfo declared for this Type and source.
-
getAppinfo
public String getAppinfo(Property property, 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 interfaceXSDHelper
- Parameters:
property
- the Property with the appinfo declarationsource
- the source of the appinfo declaration.- Returns:
- the appinfo declared for this Property and source.
-
define
public List define(String xsd)
Description copied from interface:XSDHelper
Define the XML Schema as Types. The Types are available throughTypeHelper.getType(java.lang.String, java.lang.String)
methods. Same as define(new StringReader(xsd), null)
-
define
public List define(Reader xsdReader, String schemaLocation)
Description copied from interface:XSDHelper
Define XML Schema as Types. The Types are available throughTypeHelper.getType(java.lang.String, java.lang.String)
methods.- Specified by:
define
in interfaceXSDHelper
- 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. Not all of the XML Schema types cause an SDO type to be defined (for example in case of duplicates), the returned list only includes the newly defined types.
-
define
public List define(Source xsdSource, SchemaResolver schemaResolver)
Description copied from interface:SDOXSDHelper
INTERNAL:- Specified by:
define
in interfaceSDOXSDHelper
- Returns:
-
define
public List define(InputStream xsdInputStream, String schemaLocation)
Description copied from interface:XSDHelper
Define XML Schema as Types. The Types are available throughTypeHelper.getType(java.lang.String, java.lang.String)
methods.- Specified by:
define
in interfaceXSDHelper
- 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. Not all of the XML Schema types cause an SDO type to be defined (for example in case of duplicates), the returned list only includes the newly defined types.
-
generate
public String generate(List types)
Description copied from interface:XSDHelper
Generate an XML Schema Declaration (XSD) from Types. Same as generate(types, null);
-
generate
public String generate(List types, Map namespaceToSchemaLocation)
Description copied from interface:XSDHelper
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
-
generate
public String generate(List types, SchemaLocationResolver schemaLocationResolver)
Description copied from interface:SDOXSDHelper
INTERNAL:- Specified by:
generate
in interfaceSDOXSDHelper
- Returns:
-
buildAppInfoMap
public Map buildAppInfoMap(List appInfoElements)
INTERNAL:- Specified by:
buildAppInfoMap
in interfaceSDOXSDHelper
- Returns:
-
addGlobalProperty
public void addGlobalProperty(QName qname, Property prop, boolean isElement)
INTERNAL:- Specified by:
addGlobalProperty
in interfaceSDOXSDHelper
- Parameters:
qname
-prop
-isElement
- Register the given property with the given qname.
-
getXSDHelperDelegate
public SDOXSDHelperDelegate getXSDHelperDelegate()
-
reset
public void reset()
Description copied from interface:SDOXSDHelper
INTERNAL:- Specified by:
reset
in interfaceSDOXSDHelper
-
-