org.jomc.modlet

Class Schema

java.lang.Object

org.jomc.modlet.ModletObject

org.jomc.modlet.Schema

All Implemented Interfaces:

Cloneable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class Schema
extends ModletObject
implements Cloneable

Reference to a schema. The 'Schema' type defines attributes 'public-id', 'system-id', 'context-id' and 'classpath-id'. Attribute 'public-id' holds the public identifier of the referenced schema. Attribute 'system-id' holds the system identifier of the referenced schema. Attribute 'context-id' holds the name of the Java package containing JAXB classes of the referenced schema. Attribute 'classpath-id' holds the Java classpath location of the referenced schema.

Java class for Schema complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Schema">
   <complexContent>
     <extension base="{http://jomc.org/modlet}ModletObject">
       <sequence>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="public-id" use="required" type="{http://jomc.org/modlet}URI" />
       <attribute name="system-id" use="required" type="{http://jomc.org/modlet}URI" />
       <attribute name="context-id" type="{http://jomc.org/modlet}Identifier" />
       <attribute name="classpath-id" type="{http://jomc.org/modlet}Identifier" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Object>	any
protected String	classpathId
protected String	contextId
protected String	publicId
protected String	systemId

Fields inherited from class org.jomc.modlet.ModletObject

MODEL_PUBLIC_ID, PUBLIC_ID

Constructor Summary

Constructors

Constructor and Description
Schema() Creates a new Schema instance.
Schema(Schema o) Creates a new Schema instance by deeply copying a given Schema instance.

Method Summary

Methods

Modifier and Type	Method and Description
Schema	clone() Creates and returns a deep copy of this object.
List<Object>	getAny() Gets the value of the any property.
JAXBElement	getAnyElement(String namespaceURI, String localPart) Deprecated. As of JOMC 1.1, please use method getAnyElement(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.
<T> JAXBElement<T>	getAnyElement(String namespaceURI, String localPart, Class<T> type) Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.
List<JAXBElement>	getAnyElements(String namespaceURI, String localPart) Deprecated. As of JOMC 1.1, please use method getAnyElements(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.
<T> List<JAXBElement<T>>	getAnyElements(String namespaceURI, String localPart, Class<T> type) Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.
<T> T	getAnyObject(Class<T> clazz) Gets a single object matching a given class from the any property of the instance.
<T> List<T>	getAnyObjects(Class<T> clazz) Gets a list containing all objects matching a given class from the any property of the instance.
String	getClasspathId() The Java classpath location of the referenced schema or null.
String	getContextId() The name of the Java package containing JAXB classes of the referenced schema or null.
String	getPublicId() The public identifier of the referenced schema.
URI	getPublicIdUri() Gets the public identifier of the referenced schema as an URI.
String	getSystemId() The system identifier of the referenced schema.
URI	getSystemIdUri() Gets the system identifier of the referenced schema as an URI.
void	setClasspathId(String value) Sets the value of the classpathId property.
void	setContextId(String value) Sets the value of the contextId property.
void	setPublicId(String value) Sets the value of the publicId property.
void	setSystemId(String value) Sets the value of the systemId property.

Methods inherited from class org.jomc.modlet.ModletObject

getAnyElement, getAnyElement, getAnyElements, getAnyElements, getAnyObject, getAnyObjects

Methods inherited from class java.lang.Object

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

Field Detail

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Object> any

publicId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String publicId

systemId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String systemId

contextId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String contextId

classpathId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String classpathId

Constructor Detail

Schema

public Schema()

Creates a new Schema instance.

Schema

public Schema(Schema o)

Creates a new Schema instance by deeply copying a given Schema instance.

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public List<Object> getAny()

Gets the value of the any property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any property.

For example, to add a new item, do as follows:

    getAny().add(newItem);
 

Objects of the following type(s) are allowed in the list Object Element

getPublicId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getPublicId()

The public identifier of the referenced schema.

Returns:

possible object is String

setPublicId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setPublicId(String value)

Sets the value of the publicId property.

Parameters:

value - allowed object is String

getSystemId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getSystemId()

The system identifier of the referenced schema.

Returns:

possible object is String

setSystemId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setSystemId(String value)

Sets the value of the systemId property.

Parameters:

value - allowed object is String

getContextId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getContextId()

The name of the Java package containing JAXB classes of the referenced schema or null.

Returns:

possible object is String

setContextId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setContextId(String value)

Sets the value of the contextId property.

Parameters:

value - allowed object is String

getClasspathId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getClasspathId()

The Java classpath location of the referenced schema or null.

Returns:

possible object is String

setClasspathId

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setClasspathId(String value)

Sets the value of the classpathId property.

Parameters:

value - allowed object is String

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-04T08:53:46+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Schema clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class ModletObject

Returns:

A deep copy of this object.

getAnyElement

@Deprecated
public JAXBElement getAnyElement(String namespaceURI,
                                   String localPart)

Deprecated. As of JOMC 1.1, please use method getAnyElement(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.

Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.

Parameters:

namespaceURI - The namespace URI of the JAXBElement to return.

localPart - The local part of the JAXBElement to return.

Returns:

The JAXBElement matching namespaceURI and localPart from the any property of the instance or null, if no such element is found.

Throws:

NullPointerException - if namespaceURI or localPart is null.

IllegalStateException - if the any property contains more than one matching element.

See Also:

ModletObject.getAnyElement(java.util.List, java.lang.String, java.lang.String)

getAnyElements

@Deprecated
public List<JAXBElement> getAnyElements(String namespaceURI,
                                          String localPart)

Deprecated. As of JOMC 1.1, please use method getAnyElements(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.

Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.

Parameters:

namespaceURI - The namespace URI of the JAXBElements to return.

localPart - The local part of the JAXBElements to return.

Returns:

An unmodifiable list of all JAXBElements matching namespaceURI and localPart from the any property of the instance - an empty list if no such elements are found.

Throws:

NullPointerException - if namespaceURI or localPart is null.

See Also:

ModletObject.getAnyElements(java.util.List, java.lang.String, java.lang.String)

getAnyElement

public <T> JAXBElement<T> getAnyElement(String namespaceURI,
                               String localPart,
                               Class<T> type)

Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.

Type Parameters:

T - The type the element is bound to.

Parameters:

namespaceURI - The namespace URI of the JAXBElement to return.

localPart - The local part of the JAXBElement to return.

type - The class of the type the element is bound to.

Returns:

The JAXBElement matching namespaceURI and localPart from the any property of the instance or null, if no such element is found.

Throws:

NullPointerException - if namespaceURI, localPart or type is null.

IllegalStateException - if the any property contains more than one matching element.

Since:

1.1

See Also:

ModletObject.getAnyElement(java.util.List, java.lang.String, java.lang.String, java.lang.Class)

getAnyElements

public <T> List<JAXBElement<T>> getAnyElements(String namespaceURI,
                                      String localPart,
                                      Class<T> type)

Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.

Type Parameters:

T - The type the elements are bound to.

Parameters:

namespaceURI - The namespace URI of the JAXBElements to return.

localPart - The local part of the JAXBElements to return.

type - The class of the type the elements are bound to.

Returns:

An unmodifiable list of all JAXBElements matching namespaceURI and localPart from the any property of the instance - an empty list if no such elements are found.

Throws:

NullPointerException - if namespaceURI, localPart or type is null.

Since:

1.1

See Also:

ModletObject.getAnyElements(java.util.List, java.lang.String, java.lang.String, java.lang.Class)

getAnyObject

public <T> T getAnyObject(Class<T> clazz)

Gets a single object matching a given class from the any property of the instance.

Type Parameters:

T - The type of the object to return.

Parameters:

clazz - The class to return an instance of.

Returns:

The instance of clazz from the any property of the instance or null, if no such instance is found.

Throws:

NullPointerException - if clazz is null.

IllegalStateException - if the any property contains more than one matching object.

See Also:

ModletObject.getAnyObject(java.util.List, java.lang.Class)

getAnyObjects

public <T> List<T> getAnyObjects(Class<T> clazz)

Gets a list containing all objects matching a given class from the any property of the instance.

Type Parameters:

T - The type of the objects to return.

Parameters:

clazz - The class to return all instances of.

Returns:

An unmodifiable list of all instances of clazz from the any property of the instance - an empty list if no such objects are found.

Throws:

NullPointerException - if clazz is null.

See Also:

ModletObject.getAnyObjects(java.util.List, java.lang.Class)

getPublicIdUri

public URI getPublicIdUri()

Gets the public identifier of the referenced schema as an URI.

Returns:

The public identifier of the referenced schema as an URI or null.

Since:

1.2

getSystemIdUri

public URI getSystemIdUri()

Gets the system identifier of the referenced schema as an URI.

Returns:

The system identifier of the referenced schema as an URI or null.

Since:

1.2