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

Public Member Functions
	CollectionInfo (XSType contentType, String name, String elementName)
void	generateInitializerCode (JSourceCode jsc)
String	getReadMethodName ()
String	getWriteMethodName ()
void	createAccessMethods (JClass jClass)
JMethod	getReadMethod ()
XSList	getXSList ()
String	getContentName ()
XSType	getContentType ()
FieldInfo	getContent ()
String	getElementName ()
boolean	isMultivalued ()
void	createAddMethod (JMethod method)
void	createAddInsertMethod (JMethod method)
void	createGetMethod (JMethod method)
void	createGetCollectionReferenceMethod (JMethod method)
void	createGetByIndexMethod (JMethod method)
void	createSetArrayMethod (JMethod method)
void	createSetByIndexMethod (JMethod method)
void	createSetCollectionMethod (JMethod method)
void	createSetCollectionReferenceMethod (JMethod method)
void	setCreateExtraMethods (boolean extraMethods)
void	setReferenceMethodSuffix (String suffix)
void	createGetCountMethod (JMethod method)
void	createEnumerateMethod (JMethod method)
void	createRemoveByObjectMethod (JMethod method)
void	createRemoveByIndexMethod (JMethod method)
void	createRemoveAllMethod (JMethod method)
Static Public Attributes
static final String	REFERENCE_SUFFIX_PROPERTY = "org.exolab.castor.builder.collections.reference.suffix"
static final String	DEFAULT_REFERENCE_SUFFIX = "AsReference"
Protected Member Functions
void	createBoundPropertyCode (JSourceCode jsc)
final boolean	extraMethods ()
final String	getReferenceMethodSuffix ()
Protected Attributes
XSList	xsList = null

Detailed Description

A helper used for generating source that deals with Collections

Author:: Keith Visco

Version:

Revision:: 1.3

Date:: 2004/06/26 06:51:14

Constructor & Destructor Documentation

org.exolab.castor.builder.CollectionInfo.CollectionInfo	(	XSType	contentType,
		String	name,
		String	elementName
	)

Creates a new CollectionInfo

Parameters:

	contextType	the content type of the collection, ie. the type of objects that the collection will contain
	name	the name of the Collection
	elementName	the element name for each element in collection

References org.exolab.castor.builder.FieldInfo.FieldInfo(), org.exolab.castor.builder.XMLInfo.getSchemaType(), and org.exolab.castor.builder.CollectionInfo.xsList.

Member Function Documentation

void org.exolab.castor.builder.CollectionInfo.createAccessMethods ( JClass jClass )

Creates the Access methods for the collection described by this CollectionInfo

Parameters:

jClass

the JClass to add the methods to.

Reimplemented from org.exolab.castor.builder.FieldInfo.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2.

void org.exolab.castor.builder.CollectionInfo.createAddInsertMethod ( JMethod method )

Creates implementation of add method with an index.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.types.XSList.getMaximumSize(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.castor.builder.CollectionInfo.getXSList(), org.exolab.javasource.JSourceCode.indent(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createAddMethod ( JMethod method )

Creates implementation of add method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.types.XSList.getMaximumSize(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.castor.builder.CollectionInfo.getXSList(), org.exolab.javasource.JSourceCode.indent(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode ( JSourceCode jsc ) [protected]

Creates the necessary source code for notifying PropertyChangeListeners when the collection has been updated.

Parameters:

jsc

the JSourceCode to add the new source code to.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), and org.exolab.castor.builder.FieldInfo.getName().

void org.exolab.castor.builder.CollectionInfo.createEnumerateMethod ( JMethod method )

Creates implementation of Enumerate method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.FieldInfo.getName(), and org.exolab.javasource.JMethod.getSourceCode().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createGetByIndexMethod ( JMethod method )

Creates implementation of the get(index) method.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.types.XSType.CLASS, org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getReturnType(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.javasource.JSourceCode.indent(), org.exolab.javasource.JType.toString(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createGetCollectionReferenceMethod ( JMethod method )

Creates implementation of collection reference get method. This method simply returns the actual reference to the collection.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JDocComment.addDescriptor(), org.exolab.javasource.JSourceCode.append(), org.exolab.javasource.JDocComment.appendComment(), org.exolab.castor.builder.CollectionInfo.getElementName(), org.exolab.javasource.JMethod.getJDocComment(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.javasource.JDocDescriptor.setDescription().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createGetCountMethod ( JMethod method )

Creates implementation of getCount method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.FieldInfo.getName(), and org.exolab.javasource.JMethod.getSourceCode().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods(), and org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createGetMethod ( JMethod method )

Creates implementation of object[] get() method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createRemoveAllMethod ( JMethod method )

Creates implementation of removeAll() method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.castor.builder.FieldInfo.isBound().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createRemoveByIndexMethod ( JMethod method )

Creates implementation of remove(int i) method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.types.XSType.CLASS, org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.javasource.JType.getName(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getReturnType(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.castor.builder.FieldInfo.isBound().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createRemoveByObjectMethod ( JMethod method )

Creates implementation of remove(Object) method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.castor.builder.FieldInfo.isBound().

void org.exolab.castor.builder.CollectionInfo.createSetArrayMethod ( JMethod method )

Creates implementation of array set method

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JParameter.getName(), org.exolab.javasource.JMethod.getParameter(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.javasource.JSourceCode.indent(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createSetByIndexMethod ( JMethod method )

Creates implementation of set method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.types.XSList.getMaximumSize(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.castor.builder.CollectionInfo.getXSList(), org.exolab.javasource.JSourceCode.indent(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createSetCollectionMethod ( JMethod method )

Creates implementation of collection set method. The method will assign the field a copy of the given collection. The fields will be checked for type safety.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2.

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.createSetCollectionReferenceMethod ( JMethod method )

Creates implementation of collection reference set method. This method is a non-type safe method which simply assigns the given collection to the field.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.javasource.JDocComment.appendComment(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getElementName(), org.exolab.javasource.JMethod.getJDocComment(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JParameter.getName(), org.exolab.javasource.JDocComment.getParamDescriptor(), org.exolab.javasource.JMethod.getParameter(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JDocDescriptor.setDescription().

Referenced by org.exolab.castor.builder.CollectionInfo.createAccessMethods().

final boolean org.exolab.castor.builder.CollectionInfo.extraMethods ( ) [protected]

Returns true if extra collection methods should be generated. The extra collection methods are methods which return an actual reference to the underlying collection as opposed to an enumeration, iterator, or copy.

Returns:: true if extra collection methods should be generated

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods(), and org.exolab.castor.builder.CollectionInfo.createAccessMethods().

void org.exolab.castor.builder.CollectionInfo.generateInitializerCode ( JSourceCode jsc )

Creates code for initialization of this Member

Parameters:

jsc

the JSourceCode in which to add the source to

Reimplemented from org.exolab.castor.builder.FieldInfo.

Reimplemented in org.exolab.castor.builder.CollectionInfoJ2, and org.exolab.castor.builder.CollectionInfoODMG30.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), and org.exolab.castor.builder.FieldInfo.getName().

FieldInfo org.exolab.castor.builder.CollectionInfo.getContent ( )

String org.exolab.castor.builder.CollectionInfo.getContentName ( )

XSType org.exolab.castor.builder.CollectionInfo.getContentType ( )

String org.exolab.castor.builder.CollectionInfo.getElementName ( )

JMethod org.exolab.castor.builder.CollectionInfo.getReadMethod ( )

Returns the main read method for this member

Returns:: the main read method for this member

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.types.XSType.getJType(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.castor.builder.CollectionInfo.getReadMethodName(), and org.exolab.javasource.JMethod.getSourceCode().

String org.exolab.castor.builder.CollectionInfo.getReadMethodName ( )

Returns the name of the read method for this FieldInfo

Returns:: the name of the read method for this FieldInfo

Reimplemented from org.exolab.castor.builder.FieldInfo.

References org.exolab.castor.builder.CollectionInfo.getElementName().

Referenced by org.exolab.castor.builder.CollectionInfo.getReadMethod().

final String org.exolab.castor.builder.CollectionInfo.getReferenceMethodSuffix ( ) [protected]

Returns the suffix (ending) that should be used when creating the extra collection methods

Returns:: the suffix for the reference methods

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

String org.exolab.castor.builder.CollectionInfo.getWriteMethodName ( )

Returns the name of the write method for this FieldInfo

Returns:: the name of the write method for this FieldInfo

Reimplemented from org.exolab.castor.builder.FieldInfo.

References org.exolab.castor.builder.CollectionInfo.getElementName().

XSList org.exolab.castor.builder.CollectionInfo.getXSList ( )

References org.exolab.castor.builder.CollectionInfo.xsList.

boolean org.exolab.castor.builder.CollectionInfo.isMultivalued ( )

Return whether or not this member is a multivalued member or not

Returns:: true if this member can appear more than once

Reimplemented from org.exolab.castor.builder.XMLInfo.

void org.exolab.castor.builder.CollectionInfo.setCreateExtraMethods ( boolean extraMethods )

Sets whether or not to create extra collection methods for accessing the actual collection

Parameters:

extraMethods

a boolean that when true indicates that extra collection accessor methods should be created. False by default.

See also:: setReferenceMethodSuffix

Referenced by org.exolab.castor.builder.FieldInfoFactory.createCollection().

void org.exolab.castor.builder.CollectionInfo.setReferenceMethodSuffix ( String suffix )

Sets the method suffix (ending) to use when creating the extra collection methods.

Parameters:

suffix

the method suffix to use when creating the extra collection methods. If null or emtpty the default value, as specified by DEFAULT_REFERENCE_SUFFIX will used.