org.exolab.castor.builder.info
Class XMLInfo

java.lang.Object
  extended by org.exolab.castor.builder.info.XMLInfo
Direct Known Subclasses:
ClassInfo, FieldInfo

public class XMLInfo
extends java.lang.Object

A class for storing XML related information.

Version:
$Revision: 6678 $ $Date: 2006-02-23 01:37:50 -0700 (Thu, 23 Feb 2006) $
Author:
Keith Visco

Field Summary
static short ATTRIBUTE_TYPE
          Represents the attribute node type.
static java.lang.String CHOICE_NODE_NAME_ERROR_INDICATION
          Identifies the node name for a choice group.
static short ELEMENT_TYPE
          Represents the element node type.
static short TEXT_TYPE
          Represents the text node type.
 
Constructor Summary
XMLInfo()
          Creates a new XML Info.
XMLInfo(short nodeType)
          Creates a new XMLInfo with the given node type.
XMLInfo(java.lang.String name, short nodeType)
          Creates a new XMLInfo with the given XML name and node type.
 
Method Summary
 java.lang.String getNamespacePrefix()
          Returns the namespace prefix of the object described by this XMLInfo.
 java.lang.String getNamespaceURI()
          Returns the namespace URI of the object described by this XMLInfo.
 java.lang.String getNodeName()
          Returns the XML name for the object described by this XMLInfo.
 short getNodeType()
          Returns the node type for the object described by this XMLInfo.
 java.lang.String getNodeTypeName()
          Returns the string name of the nodeType, either "attribute", "element" or "text".
 XSType getSchemaType()
          Returns the XML Schema type for the described object.
 boolean isElementDefinition()
          Returns true if XSD is global element or element with anonymous type.
 boolean isMultivalued()
          Return whether or not the object described by this XMLInfo is multi-valued (appears more than once in the XML document).
 boolean isRequired()
          Return true if the XML object described by this XMLInfo must appear at least once in the XML document (or object model).
 void setElementDefinition(boolean elementDef)
          Sets whether or not XSD is element or not.
 void setMultivalued(boolean multivalued)
          Sets whether the XML object can appear more than once in the XML document.
 void setNamespacePrefix(java.lang.String nsPrefix)
          Sets the desired namespace prefix for this XMLInfo There is no guarantee that this prefix will be used.
 void setNamespaceURI(java.lang.String nsURI)
          Sets the Namespace URI for this XMLInfo.
 void setNodeName(java.lang.String name)
          Sets the XML name of the object described by this XMLInfo.
 void setNodeType(short nodeType)
          Sets the nodeType for this XMLInfo.
 void setRequired(boolean required)
          Sets whether or not the XML object must appear at least once.
 void setSchemaType(XSType xsType)
          Sets the XML Schema type for this XMLInfo.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTRIBUTE_TYPE

public static final short ATTRIBUTE_TYPE
Represents the attribute node type.

See Also:
Constant Field Values

ELEMENT_TYPE

public static final short ELEMENT_TYPE
Represents the element node type.

See Also:
Constant Field Values

TEXT_TYPE

public static final short TEXT_TYPE
Represents the text node type.

See Also:
Constant Field Values

CHOICE_NODE_NAME_ERROR_INDICATION

public static final java.lang.String CHOICE_NODE_NAME_ERROR_INDICATION
Identifies the node name for a choice group.

See Also:
Constant Field Values
Constructor Detail

XMLInfo

public XMLInfo()
Creates a new XML Info.


XMLInfo

public XMLInfo(short nodeType)
Creates a new XMLInfo with the given node type.

Parameters:
nodeType - the nodeType which this XMLInfo represents

XMLInfo

public XMLInfo(java.lang.String name,
               short nodeType)
Creates a new XMLInfo with the given XML name and node type.

Parameters:
name - the xml node name
nodeType - the nodeType which this XMLInfo represents
Method Detail

getNodeName

public final java.lang.String getNodeName()
Returns the XML name for the object described by this XMLInfo.

Returns:
the XML name for the object described by this XMLInfo, or null if no name has been set

getNamespacePrefix

public final java.lang.String getNamespacePrefix()
Returns the namespace prefix of the object described by this XMLInfo.

Returns:
the namespace prefix of the object described by this XMLInfo

getNamespaceURI

public final java.lang.String getNamespaceURI()
Returns the namespace URI of the object described by this XMLInfo.

Returns:
the namespace URI of the object described by this XMLInfo

isElementDefinition

public final boolean isElementDefinition()
Returns true if XSD is global element or element with anonymous type.

Returns:
true if xsd is element

getNodeType

public final short getNodeType()
Returns the node type for the object described by this XMLInfo.

Returns:
the node type for the object described by this XMLInfo

getNodeTypeName

public final java.lang.String getNodeTypeName()
Returns the string name of the nodeType, either "attribute", "element" or "text".

Returns:
the name of the node-type of the object described by this XMLInfo.

getSchemaType

public final XSType getSchemaType()
Returns the XML Schema type for the described object.

Returns:
the XML Schema type.

isMultivalued

public boolean isMultivalued()
Return whether or not the object described by this XMLInfo is multi-valued (appears more than once in the XML document).

Returns:
true if this object can appear more than once.

isRequired

public final boolean isRequired()
Return true if the XML object described by this XMLInfo must appear at least once in the XML document (or object model).

Returns:
true if the XML object must appear at least once.

setMultivalued

public final void setMultivalued(boolean multivalued)
Sets whether the XML object can appear more than once in the XML document.

Parameters:
multivalued - The boolean indicating whether or not the object can appear more than once.

setNodeName

public final void setNodeName(java.lang.String name)
Sets the XML name of the object described by this XMLInfo.

Parameters:
name - the XML node name of the described object.

setNamespacePrefix

public final void setNamespacePrefix(java.lang.String nsPrefix)
Sets the desired namespace prefix for this XMLInfo There is no guarantee that this prefix will be used.

Parameters:
nsPrefix - the desired namespace prefix

setNamespaceURI

public final void setNamespaceURI(java.lang.String nsURI)
Sets the Namespace URI for this XMLInfo.

Parameters:
nsURI - the Namespace URI for this XMLInfo

setElementDefinition

public final void setElementDefinition(boolean elementDef)
Sets whether or not XSD is element or not.

Parameters:
elementDef - The flag indicating whether or not XSD is global element, element with anonymous type or not.

setNodeType

public final void setNodeType(short nodeType)
Sets the nodeType for this XMLInfo.

Parameters:
nodeType - the node type of the described object

setSchemaType

public final void setSchemaType(XSType xsType)
Sets the XML Schema type for this XMLInfo.

Parameters:
xsType - the XML Schema type

setRequired

public final void setRequired(boolean required)
Sets whether or not the XML object must appear at least once.

Parameters:
required - the flag indicating whether or not this XML object is required


Intalio Inc. (C) 1999-2007. All rights reserved http://www.intalio.com