org.exolab.castor.builder

Class CollectionInfo

java.lang.Object

org.exolab.castor.builder.XMLInfo

org.exolab.castor.builder.FieldInfo

org.exolab.castor.builder.CollectionInfo

Direct Known Subclasses:

CollectionInfoJ2, CollectionInfoODMG30

public class CollectionInfo
extends FieldInfo

A helper used for generating source that deals with Collections

Version:

$Revision: 6387 $ $Date: 2006-02-23 01:08:24 -0700 (Thu, 23 Feb 2006) $

Author:

Keith Visco

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_REFERENCE_SUFFIX
static java.lang.String	REFERENCE_SUFFIX_PROPERTY The property used to overwrite the reference suffix for extra collection methods

Fields inherited from class org.exolab.castor.builder.FieldInfo

READ_METHOD, READ_WRITE_METHODS, WRITE_METHOD

Fields inherited from class org.exolab.castor.builder.XMLInfo

ATTRIBUTE_TYPE, CHOICE_NODE_NAME_ERROR_INDICATION, ELEMENT_TYPE, TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
CollectionInfo(XSType contentType, java.lang.String name, java.lang.String elementName, boolean useJava50) Creates a new CollectionInfo

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addMaxSizeCheck(java.lang.String methodName, JSourceCode sourceCode)
void	createAccessMethods(JClass jClass, boolean useJava50) Generate the various accessor methods.
protected void	createAddAndRemoveMethods(JClass jClass)
protected void	createAddMethod(JClass jClass)
protected void	createBoundPropertyCode(JSourceCode sourceCode) Creates the necessary source code for notifying PropertyChangeListeners when the collection has been updated.
protected void	createCollectionIterationMethods(JClass jClass, boolean useJava50) Generate methods for iterating over the objects in the collection.
protected void	createEnumerateMethod(JClass jClass, boolean useJava50)
protected boolean	createExtraMethods() Returns true if extra collection methods should be generated.
protected void	createGetAndSetMethods(JClass jClass, boolean useJava50)
protected void	createGetAsArrayMethod(JClass jClass, boolean useJava50)
protected void	createGetAsReferenceMethod(JClass jClass)
protected void	createGetByIndexMethod(JClass jClass)
protected void	createGetCountMethod(JClass jClass)
protected void	createInsertMethod(JClass jClass)
protected void	createIteratorMethod(JClass jClass, boolean useJava50)
protected void	createRemoveAllMethod(JClass jClass) Creates implementation of removeAll() method.
protected void	createRemoveByIndexMethod(JClass jClass) Creates implementation of remove(int i) method.
protected void	createRemoveObjectMethod(JClass jClass) Creates implementation of remove(Object) method.
protected void	createSetAsArrayMethod(JClass jClass, boolean useJava50)
protected void	createSetAsCopyMethod(JClass jClass) Creates implementation of collection set method.
protected void	createSetAsReferenceMethod(JClass jClass, boolean useJava50) Creates implementation of collection reference set method.
protected void	createSetByIndexMethod(JClass jClass)
void	generateInitializerCode(JSourceCode sourceCode) Creates code for initialization of this Member.
FieldInfo	getContent()
java.lang.String	getContentName()
XSType	getContentType()
java.lang.String	getElementName()
protected java.lang.String	getMethodSuffix() Returns the method suffix for creating method names.
protected java.lang.String	getReferenceMethodSuffix() Returns the suffix (ending) that should be used when creating the extra collection methods.
XSList	getXSList()
boolean	isMultivalued() Return whether or not the object described by this XMLInfo is multi-valued (appears more than once in the XML document).
void	setCreateExtraMethods(boolean extraMethods) Sets whether or not to create extra collection methods for accessing the actual collection.
void	setReferenceMethodSuffix(java.lang.String suffix) Sets the method suffix (ending) to use when creating the extra collection methods.

Methods inherited from class org.exolab.castor.builder.FieldInfo

createGetterComment, createGetterMethod, createHasAndDeleteMethods, createJavaField, createSetterComment, createSetterMethod, getComment, getDeclaringClassInfo, getDefaultValue, getDeleteMethodName, getFixedValue, getHasMethodName, getMethods, getName, getReadMethodName, getValidator, getWriteMethodName, getXMLFieldHandler, isBound, isContainer, isHasAndDeleteMethods, isNillable, isTransient, setBound, setComment, setContainer, setDeclaringClassInfo, setDefaultValue, setFieldInfoReference, setFinal, setFixedValue, setMethods, setNillable, setStatic, setTransient, setValidator, setXMLFieldHandler

Methods inherited from class org.exolab.castor.builder.XMLInfo

getNamespacePrefix, getNamespaceURI, getNodeName, getNodeType, getNodeTypeName, getSchemaType, isElementDefinition, isRequired, setElementDefinition, setMultivalued, setNamespacePrefix, setNamespaceURI, setNodeName, setNodeType, setRequired, setSchemaType

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REFERENCE_SUFFIX

public static final java.lang.String DEFAULT_REFERENCE_SUFFIX

See Also:

Constant Field Values

REFERENCE_SUFFIX_PROPERTY

public static final java.lang.String REFERENCE_SUFFIX_PROPERTY

The property used to overwrite the reference suffix for extra collection methods

See Also:

Constant Field Values

Constructor Detail

CollectionInfo

public CollectionInfo(XSType contentType,
              java.lang.String name,
              java.lang.String elementName,
              boolean useJava50)

Creates a new CollectionInfo

Parameters:

contentType - 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

useJava50 - true if source code is supposed to be generated for Java 5

Method Detail

createAccessMethods

public void createAccessMethods(JClass jClass,
                       boolean useJava50)

Generate the various accessor methods. Creates the access methods for field associated with this FieldInfo. The access methods include getters, setters, and "has" and "delete" methods if necessary.

Overrides:

createAccessMethods in class FieldInfo

Parameters:

jClass - the JClass to add the methods to

useJava50 - true if source code is supposed to be generated for Java 5

See Also:

FieldInfo.createAccessMethods(org.exolab.javasource.JClass, boolean)

generateInitializerCode

public void generateInitializerCode(JSourceCode sourceCode)

Creates code for initialization of this Member.

Overrides:

generateInitializerCode in class FieldInfo

Parameters:

sourceCode - the JSourceCode in which to add the source to

See Also:

FieldInfo.generateInitializerCode(org.exolab.javasource.JSourceCode)

getContent

public FieldInfo getContent()

getContentName

public java.lang.String getContentName()

getContentType

public XSType getContentType()

getElementName

public java.lang.String getElementName()

getXSList

public XSList getXSList()

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).

Overrides:

isMultivalued in class XMLInfo

Returns:

true if this object can appear more than once.

See Also:

XMLInfo.isMultivalued()

setCreateExtraMethods

public void 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(java.lang.String)

setReferenceMethodSuffix

public void setReferenceMethodSuffix(java.lang.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.

See Also:

setCreateExtraMethods(boolean)

addMaxSizeCheck

protected void addMaxSizeCheck(java.lang.String methodName,
                   JSourceCode sourceCode)

createAddMethod

protected void createAddMethod(JClass jClass)

createBoundPropertyCode

protected void createBoundPropertyCode(JSourceCode sourceCode)

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

Parameters:

sourceCode - the JSourceCode to add the new source code to.

createEnumerateMethod

protected void createEnumerateMethod(JClass jClass,
                         boolean useJava50)

createExtraMethods

protected final boolean createExtraMethods()

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

createGetAsArrayMethod

protected void createGetAsArrayMethod(JClass jClass,
                          boolean useJava50)

createGetAsReferenceMethod

protected void createGetAsReferenceMethod(JClass jClass)

createGetByIndexMethod

protected void createGetByIndexMethod(JClass jClass)

createAddAndRemoveMethods

protected void createAddAndRemoveMethods(JClass jClass)

Parameters:

jClass -

createGetAndSetMethods

protected void createGetAndSetMethods(JClass jClass,
                          boolean useJava50)

Parameters:

jClass - the JClass to which we add this method

useJava50 - true if source code is supposed to be generated for Java 5

createGetCountMethod

protected void createGetCountMethod(JClass jClass)

createCollectionIterationMethods

protected void createCollectionIterationMethods(JClass jClass,
                                    boolean useJava50)

Generate methods for iterating over the objects in the collection. For Java-1 collections, we only generate an Enumerator. Implementations for other versions of Java should call this method for backward compatbility and then add any additional new methods.

Parameters:

jClass - the JClass to which we add this method

useJava50 - true if source code is supposed to be generated for Java 5

createInsertMethod

protected void createInsertMethod(JClass jClass)

createIteratorMethod

protected void createIteratorMethod(JClass jClass,
                        boolean useJava50)

createRemoveAllMethod

protected void createRemoveAllMethod(JClass jClass)

Creates implementation of removeAll() method.

Parameters:

jClass - the JClass to which we add this method

createRemoveByIndexMethod

protected void createRemoveByIndexMethod(JClass jClass)

Creates implementation of remove(int i) method.

Parameters:

jClass - the JClass to which we add this method

createRemoveObjectMethod

protected void createRemoveObjectMethod(JClass jClass)

Creates implementation of remove(Object) method.

Parameters:

jClass - the JClass to which we add this method

createSetAsArrayMethod

protected void createSetAsArrayMethod(JClass jClass,
                          boolean useJava50)

createSetAsCopyMethod

protected void createSetAsCopyMethod(JClass jClass)

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:

jClass -

createSetAsReferenceMethod

protected void createSetAsReferenceMethod(JClass jClass,
                              boolean useJava50)

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:

jClass -

useJava50 - true if source code is supposed to be generated for Java 5

createSetByIndexMethod

protected void createSetByIndexMethod(JClass jClass)

getMethodSuffix

protected java.lang.String getMethodSuffix()

Returns the method suffix for creating method names.

Overrides:

getMethodSuffix in class FieldInfo

Returns:

the method suffix used when creating method names.

See Also:

FieldInfo.getMethodSuffix()

getReferenceMethodSuffix

protected final java.lang.String getReferenceMethodSuffix()

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

Returns:

the suffix for the reference methods