Public Member Functions | Static Public Attributes

org.exolab.castor.builder.XMLInfo Class Reference

Inheritance diagram for org.exolab.castor.builder.XMLInfo:
org.exolab.castor.builder.ClassInfo org.exolab.castor.builder.FieldInfo org.exolab.castor.builder.CollectionInfo org.exolab.castor.builder.IdentityInfo org.exolab.castor.builder.CollectionInfoJ2 org.exolab.castor.builder.CollectionInfoODMG30

List of all members.

Public Member Functions

 XMLInfo ()
 XMLInfo (short nodeType)
 XMLInfo (String name, short nodeType)
String getNodeName ()
String getNamespacePrefix ()
String getNamespaceURI ()
short getNodeType ()
String getNodeTypeName ()
XSType getSchemaType ()
boolean isMultivalued ()
boolean isRequired ()
void setMultivalued (boolean multivalued)
void setNodeName (String name)
void setNamespacePrefix (String nsPrefix)
void setNamespaceURI (String nsURI)
void setNodeType (short nodeType)
void setSchemaType (XSType xsType)
void setRequired (boolean required)

Static Public Attributes

static final short ATTRIBUTE_TYPE = 0
static final short ELEMENT_TYPE = 1
static final short TEXT_TYPE = 2

Detailed Description

A class for storing XML related information

Author:
Keith Visco
Version:
Revision:
1.1.1.1
Date:
2003/03/03 07:07:48

Constructor & Destructor Documentation

org.exolab.castor.builder.XMLInfo.XMLInfo (  ) 

Creates a new XML Info

org.exolab.castor.builder.XMLInfo.XMLInfo ( short  nodeType  ) 

Creates a new XMLInfo with the given node type

Parameters:
nodeType the nodeType which this XMLInfo represents
org.exolab.castor.builder.XMLInfo.XMLInfo ( 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

Member Function Documentation

String org.exolab.castor.builder.XMLInfo.getNamespacePrefix (  ) 

Returns the namespace prefix of the object described by this XMLInfo

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

Referenced by org.exolab.castor.builder.DescriptorSourceFactory.createSource().

String org.exolab.castor.builder.XMLInfo.getNamespaceURI (  ) 

Returns the namespace URI of the object described by this XMLInfo

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

Referenced by org.exolab.castor.builder.DescriptorSourceFactory.createSource().

String org.exolab.castor.builder.XMLInfo.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

Referenced by org.exolab.castor.builder.DescriptorSourceFactory.createSource(), org.exolab.castor.builder.ClassInfo.getAttributeField(), and org.exolab.castor.builder.ClassInfo.getElementField().

short org.exolab.castor.builder.XMLInfo.getNodeType (  ) 

Returns the node type for the object described by this XMLInfo

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

Referenced by org.exolab.castor.builder.ClassInfo.addFieldInfo(), and org.exolab.castor.builder.ClassInfo.contains().

String org.exolab.castor.builder.XMLInfo.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.

References org.exolab.castor.builder.XMLInfo.ATTRIBUTE_TYPE, org.exolab.castor.builder.XMLInfo.ELEMENT_TYPE, and org.exolab.castor.builder.XMLInfo.TEXT_TYPE.

XSType org.exolab.castor.builder.XMLInfo.getSchemaType (  ) 

Returns the XML Schema type for the described object

Returns:
the XML Schema type

Referenced by org.exolab.castor.builder.CollectionInfo.CollectionInfo(), org.exolab.castor.builder.CollectionInfoJ2.CollectionInfoJ2(), org.exolab.castor.builder.CollectionInfoODMG30.CollectionInfoODMG30(), org.exolab.castor.builder.IdentityInfo.createAccessMethods(), org.exolab.castor.builder.FieldInfo.createAccessMethods(), org.exolab.castor.builder.MemberFactory.createFieldInfo(), org.exolab.castor.builder.FieldInfo.createJavaField(), and org.exolab.castor.builder.FieldInfo.generateInitializerCode().

boolean org.exolab.castor.builder.XMLInfo.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

Reimplemented in org.exolab.castor.builder.CollectionInfo.

Referenced by org.exolab.castor.builder.FieldInfo.getWriteMethodName().

boolean org.exolab.castor.builder.XMLInfo.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
void org.exolab.castor.builder.XMLInfo.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
void org.exolab.castor.builder.XMLInfo.setNamespacePrefix ( 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
void org.exolab.castor.builder.XMLInfo.setNamespaceURI ( String  nsURI  ) 

Sets the Namespace URI for this XMLInfo

Parameters:
nsURI the Namespace URIfor this XMLInfo

Referenced by org.exolab.castor.builder.MemberFactory.createFieldInfo(), org.exolab.castor.builder.MemberFactory.createFieldInfoForAny(), and org.exolab.castor.builder.SourceFactory.createSourceCode().

void org.exolab.castor.builder.XMLInfo.setNodeName ( String  name  ) 

Sets the XML name of the object described by this XMLInfo.

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

Referenced by org.exolab.castor.builder.MemberFactory.createFieldInfo(), org.exolab.castor.builder.MemberFactory.createFieldInfoForAny(), org.exolab.castor.builder.MemberFactory.createFieldInfoForContent(), and org.exolab.castor.builder.SourceFactory.createSourceCode().

void org.exolab.castor.builder.XMLInfo.setNodeType ( short  nodeType  ) 

Sets the nodeType for this XMLInfo

Parameters:
nodeType the node type of the described object

Referenced by org.exolab.castor.builder.MemberFactory.createFieldInfo(), org.exolab.castor.builder.MemberFactory.createFieldInfoForContent(), and org.exolab.castor.builder.IdentityInfo.IdentityInfo().

void org.exolab.castor.builder.XMLInfo.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

Referenced by org.exolab.castor.builder.MemberFactory.createFieldInfo(), org.exolab.castor.builder.MemberFactory.createFieldInfoForAny(), and org.exolab.castor.builder.MemberFactory.createFieldInfoForContent().

void org.exolab.castor.builder.XMLInfo.setSchemaType ( XSType  xsType  ) 

Sets the XML Schema type for this XMLInfo

Parameters:
xsType the XML Schema type

Referenced by org.exolab.castor.builder.CollectionInfoJ2.CollectionInfoJ2(), org.exolab.castor.builder.CollectionInfoODMG30.CollectionInfoODMG30(), org.exolab.castor.builder.SourceFactory.createSourceCode(), and org.exolab.castor.builder.FieldInfo.FieldInfo().

Member Data Documentation

final short org.exolab.castor.builder.XMLInfo.ATTRIBUTE_TYPE = 0 [static]

Represents the attribute node type

Referenced by org.exolab.castor.builder.XMLInfo.getNodeTypeName().

final short org.exolab.castor.builder.XMLInfo.ELEMENT_TYPE = 1 [static]

Represents the element node type

Referenced by org.exolab.castor.builder.XMLInfo.getNodeTypeName().

final short org.exolab.castor.builder.XMLInfo.TEXT_TYPE = 2 [static]

Represents the text node type

Referenced by org.exolab.castor.builder.XMLInfo.getNodeTypeName().

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:15:37 for ACS-10.0 Java API by  doxygen 1.7.0