EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.oxm.schema
Class XMLSchemaReference

java.lang.Object
  extended by 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
protected  java.lang.String resource
          The string used to access the XMLSchema, be it classpath resource, URL, or file name
protected  java.lang.String schemaContext
          The path to a simple/complex type definition or element in the schema
protected  javax.xml.namespace.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
protected XMLSchemaReference()
          The default constructor.
protected XMLSchemaReference(java.lang.String resource)
          This constructor takes a string that references an XMLSchema.
 
Method Summary
 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 schema
 javax.xml.namespace.QName getSchemaContextAsQName()
           
 javax.xml.namespace.QName getSchemaContextAsQName(NamespaceResolver nsResolver)
           
 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.sessions.AbstractSession session)
          Allow subclasses to perform initialization if required.
 boolean isGlobalDefinition()
          Indicates a global definition
 boolean 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 schema
 void 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

resource

protected java.lang.String resource
The string used to access the XMLSchema, be it classpath resource, URL, or file name


schemaContext

protected java.lang.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 javax.xml.namespace.QName schemaContextAsQName
Constructor Detail

XMLSchemaReference

protected XMLSchemaReference()
The default constructor.


XMLSchemaReference

protected XMLSchemaReference(java.lang.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 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 interface XMLSchemaReference
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 interface XMLSchemaReference
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 interface XMLSchemaReference
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(NamespaceResolver nsResolver)

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.sessions.AbstractSession session)
Allow subclasses to perform initialization if required. This method will typically be called during the owning descriptor's initialization phase.

Parameters:
session -

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference