Inheritance diagram for org.exolab.castor.builder.ClassInfo:

Public Member Functions
	ClassInfo (JClass jClass)
void	addFieldInfo (FieldInfo fieldInfo)
void	addFieldInfo (FieldInfo[] fields)
boolean	allowContent ()
boolean	contains (FieldInfo fieldInfo)
FieldInfo[]	getAttributeFields ()
FieldInfo	getAttributeField (String nodeName)
ClassInfo	getBaseClass ()
FieldInfo[]	getElementFields ()
FieldInfo	getElementField (String nodeName)
int	getFieldCount ()
GroupInfo	getGroupInfo ()
JClass	getJClass ()
FieldInfo	getTextField ()
boolean	isAbstract ()
boolean	isChoice ()
boolean	isContainer ()
boolean	isSequence ()
void	setAbstract (boolean abstractClass)
void	setBaseClass (ClassInfo base)
void	setContainer (boolean isContainer)

Detailed Description

This class holds the necessary information so that the source generator can properly create the necessary Classes for the Object model.

Author:: Keith Visco

Version:

Revision:: 1.1.1.1

Date:: 2003/03/03 07:07:41

Constructor & Destructor Documentation

org.exolab.castor.builder.ClassInfo.ClassInfo ( JClass jClass )

Creates a new ClassInfo

Parameters:

jClass

the JClass which this ClassInfo describes

Member Function Documentation

void org.exolab.castor.builder.ClassInfo.addFieldInfo ( FieldInfo fieldInfo )

Adds the given FieldInfo to this ClassInfo

Parameters:

fieldInfo

the FieldInfo to add

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

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

void org.exolab.castor.builder.ClassInfo.addFieldInfo ( FieldInfo[] fields )

Adds the given set of FieldInfos to this ClassInfo

Parameters:

fields

an Array of FieldInfo objects

References org.exolab.castor.builder.ClassInfo.addFieldInfo().

boolean org.exolab.castor.builder.ClassInfo.allowContent ( )

Returns:: true if Classes created with this ClassInfo allow content

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

boolean org.exolab.castor.builder.ClassInfo.contains ( FieldInfo fieldInfo )

Returns true if the given FieldInfo is contained within this ClassInfo

Returns:: true if the given FieldInfo is contained within this ClassInfo

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

FieldInfo org.exolab.castor.builder.ClassInfo.getAttributeField ( String nodeName )

Returns a fieldInfo that corresponds to an attribute with the given node name. A ClassInfo cannot have 2 attributes with the same xml name.

Parameters:

nodeName

the NodeName of the field to get.

Returns:: a fieldInfo that corresponds to an attribute with the given node name.

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

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

FieldInfo [] org.exolab.castor.builder.ClassInfo.getAttributeFields ( )

Returns an array of XML attribute associated fields

Returns:: an array of XML attribute associated fields

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

ClassInfo org.exolab.castor.builder.ClassInfo.getBaseClass ( )

Returns the base class of this classInfo if any. A classInfo can indeed extend another classInfo to reflect the extension mechanism used in the XML Schema

Returns:: the base class of this classInfo if any.

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

FieldInfo org.exolab.castor.builder.ClassInfo.getElementField ( String nodeName )

Returns a fieldInfo that corresponds to an element with the given node name. A ClassInfo cannot have 2 elements with the same xml name.

Parameters:

nodeName

the NodeName of the field to get.

Returns:: a fieldInfo that corresponds to an element with the given node name.

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

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

FieldInfo [] org.exolab.castor.builder.ClassInfo.getElementFields ( )

Returns an array of XML element associated fields

Returns:: an array of XML element associated fields

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

int org.exolab.castor.builder.ClassInfo.getFieldCount ( )

Returns the number of FieldInfo definitions for this ClassInfo.

Returns:: the number of FieldInfo definitions for this ClassInfo.

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

GroupInfo org.exolab.castor.builder.ClassInfo.getGroupInfo ( )

Returns the GroupInfo for this ClassInfo

Returns:: the GroupInfo for this ClassInfo

Referenced by org.exolab.castor.builder.SourceFactory.createSourceCode().

JClass org.exolab.castor.builder.ClassInfo.getJClass ( )

Returns the JClass described by this ClassInfo

Returns:: the JClass which is described by this ClassInfo

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

FieldInfo org.exolab.castor.builder.ClassInfo.getTextField ( )

Returns the FieldInfo for the XML text associated field.

Returns:: the FieldInfo for the text content associated field, this may be null.

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

boolean org.exolab.castor.builder.ClassInfo.isAbstract ( )

boolean org.exolab.castor.builder.ClassInfo.isChoice ( )

Returns true if the compositor of this GroupInfo is a choice

Returns:: true if the compositor of this GroupInfo is a choice

References org.exolab.castor.builder.GroupInfo.isChoice().

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

boolean org.exolab.castor.builder.ClassInfo.isContainer ( )

Returns true if this ClassInfo describes a container class. A container class is a class which should not be marshalled as XML, but whose members should be.

Returns:: true if this ClassInfo describes a container class.

boolean org.exolab.castor.builder.ClassInfo.isSequence ( )

Returns true if the compositor of this GroupInfo is a sequence

Returns:: true if the compositor of this GroupInfo is a sequence

References org.exolab.castor.builder.GroupInfo.isSequence().

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

void org.exolab.castor.builder.ClassInfo.setAbstract ( boolean abstractClass )

Referenced by org.exolab.castor.builder.SourceFactory.createSourceCode().

void org.exolab.castor.builder.ClassInfo.setBaseClass ( ClassInfo base )

Sets the base class of this classInfo. A classInfo can indeed extend another classInfo to reflect the extension mechanism used in the XML Schema

Parameters:

the

base class of this classInfo.

void org.exolab.castor.builder.ClassInfo.setContainer ( boolean isContainer )

Sets whether or not this ClassInfo describes a container class. A container class is a class which should not be marshalled as XML, but whose members should be. By default this is false.

Parameters:

isContainer

the boolean value when true indicates this class should be a container class.

Referenced by org.exolab.castor.builder.SourceFactory.createSourceCode().

The documentation for this class was generated from the following file:

ClassInfo.java

All Classes Namespaces Files Functions Variables Enumerations Properties

org.exolab.castor.builder.ClassInfo Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation