Class XMLSchemaReference
- java.lang.Object
-
- org.eclipse.persistence.oxm.schema.XMLSchemaReference
-
- All Implemented Interfaces:
XMLSchemaReference
- Direct Known Subclasses:
XMLSchemaClassPathReference
,XMLSchemaFileReference
,XMLSchemaURLReference
public abstract class XMLSchemaReference extends java.lang.Object implements XMLSchemaReference
Provides a way for a descriptor's reference to its schema to be specified. The schema can be reference through a classpath resource, a file or URL.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.persistence.platform.xml.XMLSchemaReference
COMPLEX_TYPE, ELEMENT, GROUP, SIMPLE_TYPE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.String
getResource()
java.lang.String
getSchemaContext()
Get the path to the simple/complex type definition, element or group to be referenced in the schemajavax.xml.namespace.QName
getSchemaContextAsQName()
javax.xml.namespace.QName
getSchemaContextAsQName(org.eclipse.persistence.internal.oxm.NamespaceResolver nsResolver)
INTERNAL:int
getType()
Indicates if the schema reference references a simple type definition, complex type definition, element, or group.abstract java.net.URL
getURL()
A URL which referenes the Schema.void
initialize(org.eclipse.persistence.internal.core.sessions.CoreAbstractSession session)
Allow subclasses to perform initialization if required.boolean
isGlobalDefinition()
Indicates a global definitionboolean
isValid(org.w3c.dom.Document document, org.xml.sax.ErrorHandler errorHandler)
void
setResource(java.lang.String resource)
void
setSchemaContext(java.lang.String schemaContext)
Set the path to the simple/complex type definition, element, or group to be referenced in the schemavoid
setSchemaContextAsQName(javax.xml.namespace.QName qname)
void
setType(int type)
Set to indicate if the schema reference references a simple type definition, complex type definition, element or group.
-
-
-
Method Detail
-
getResource
public java.lang.String getResource()
-
setResource
public void setResource(java.lang.String resource)
-
getURL
public abstract java.net.URL getURL()
Description copied from interface:XMLSchemaReference
A URL which referenes the Schema.- Specified by:
getURL
in interfaceXMLSchemaReference
- Returns:
- the schema URL
-
getType
public int getType()
Indicates if the schema reference references a simple type definition, complex type definition, element, or group.- Specified by:
getType
in interfaceXMLSchemaReference
- Returns:
- COMPLEX_TYPE=1, SIMPLE_TYPE=2, ELEMENT=3, GROUP=5
-
setType
public void setType(int type)
Set to indicate if the schema reference references a simple type definition, complex type definition, element or group.- Parameters:
type
- - COMPLEX_TYPE=1, SIMPLE_TYPE=2, ELEMENT=3, GROUP=5
-
getSchemaContext
public java.lang.String getSchemaContext()
Get the path to the simple/complex type definition, element or group to be referenced in the schema- Specified by:
getSchemaContext
in interfaceXMLSchemaReference
- Returns:
- the schema context
-
setSchemaContext
public void setSchemaContext(java.lang.String schemaContext)
Set the path to the simple/complex type definition, element, or group to be referenced in the schema- Parameters:
schemaContext
- - the schema context
-
setSchemaContextAsQName
public void setSchemaContextAsQName(javax.xml.namespace.QName qname)
-
getSchemaContextAsQName
public javax.xml.namespace.QName getSchemaContextAsQName()
-
getSchemaContextAsQName
public javax.xml.namespace.QName getSchemaContextAsQName(org.eclipse.persistence.internal.oxm.NamespaceResolver nsResolver)
INTERNAL:- Parameters:
nsResolver
-- Returns:
-
isValid
public boolean isValid(org.w3c.dom.Document document, org.xml.sax.ErrorHandler errorHandler)
-
isGlobalDefinition
public boolean isGlobalDefinition()
Indicates a global definition
-
initialize
public void initialize(org.eclipse.persistence.internal.core.sessions.CoreAbstractSession session)
Allow subclasses to perform initialization if required. This method will typically be called during the owning descriptor's initialization phase.- Parameters:
session
-
-
-