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 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 Modifier and Type Field Description protected String
resource
The string used to access the XMLSchema, be it classpath resource, URL, or file nameprotected String
schemaContext
The path to a simple/complex type definition or element in the schemaprotected QName
schemaContextAsQName
protected int
type
Indicates if a simple/complex type definition, element, or group is being referenced-
Fields inherited from interface org.eclipse.persistence.platform.xml.XMLSchemaReference
COMPLEX_TYPE, ELEMENT, GROUP, SIMPLE_TYPE
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
XMLSchemaReference()
The default constructor.protected
XMLSchemaReference(String resource)
This constructor takes a string that references an XMLSchema.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description String
getResource()
String
getSchemaContext()
Get the path to the simple/complex type definition, element or group to be referenced in the schemaQName
getSchemaContextAsQName()
QName
getSchemaContextAsQName(NamespaceResolver nsResolver)
INTERNAL:int
getType()
Indicates if the schema reference references a simple type definition, complex type definition, element, or group.abstract URL
getURL()
A URL which referenes the Schema.void
initialize(CoreAbstractSession session)
Allow subclasses to perform initialization if required.boolean
isGlobalDefinition()
Indicates a global definitionboolean
isValid(Document document, ErrorHandler errorHandler)
void
setResource(String resource)
void
setSchemaContext(String schemaContext)
Set the path to the simple/complex type definition, element, or group to be referenced in the schemavoid
setSchemaContextAsQName(QName qname)
void
setType(int type)
Set to indicate if the schema reference references a simple type definition, complex type definition, element or group.
-
-
-
Field Detail
-
resource
protected String resource
The string used to access the XMLSchema, be it classpath resource, URL, or file name
-
schemaContext
protected String schemaContext
The path to a simple/complex type definition or element in the schema
-
type
protected int type
Indicates if a simple/complex type definition, element, or group is being referenced
-
schemaContextAsQName
protected QName schemaContextAsQName
-
-
Constructor Detail
-
XMLSchemaReference
protected XMLSchemaReference()
The default constructor.
-
XMLSchemaReference
protected XMLSchemaReference(String resource)
This constructor takes a string that references an XMLSchema.- Parameters:
resource
- - used to access the XMLSchema (classpath, URL, or file name)
-
-
Method Detail
-
getResource
public String getResource()
-
setResource
public void setResource(String resource)
-
getURL
public abstract 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 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(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(QName qname)
-
getSchemaContextAsQName
public QName getSchemaContextAsQName()
-
getSchemaContextAsQName
public QName getSchemaContextAsQName(NamespaceResolver nsResolver)
INTERNAL:- Parameters:
nsResolver
-- Returns:
-
isValid
public boolean isValid(Document document, ErrorHandler errorHandler)
-
isGlobalDefinition
public boolean isGlobalDefinition()
Indicates a global definition
-
initialize
public void initialize(CoreAbstractSession session)
Allow subclasses to perform initialization if required. This method will typically be called during the owning descriptor's initialization phase.- Parameters:
session
-
-
-