org.jibx.binding.model

Class CollectionElement

java.lang.Object

org.jibx.binding.model.ElementBase

org.jibx.binding.model.NestingElementBase

org.jibx.binding.model.ContainerElementBase

org.jibx.binding.model.StructureElementBase

org.jibx.binding.model.CollectionElement

All Implemented Interfaces:

IComponent

public class CollectionElement
extends StructureElementBase

Model component for collection element of binding definition.

Version:

1.0

Author:

Dennis M. Sosnoski

Property Summary

Properties inherited from class org.jibx.binding.model.StructureElementBase

hasProperty

Field Summary

Fields

Modifier and Type	Field and Description
static StringArray	s_allowedAttributes Enumeration of allowed attribute names

Fields inherited from class org.jibx.binding.model.ElementBase

BINDING_ELEMENT, COLLECTION_ELEMENT, ELEMENT_NAMES, FORMAT_ELEMENT, INCLUDE_ELEMENT, INPUT_ELEMENT, MAPPING_ELEMENT, NAMESPACE_ELEMENT, OUTPUT_ELEMENT, SPLIT_ELEMENT, STRUCTURE_ELEMENT, TEMPLATE_ELEMENT, VALUE_ELEMENT

Constructor Summary

Constructors

Constructor and Description
CollectionElement() Default constructor.

Method Summary

Modifier and Type	Method and Description
IClassItem	getAddMethodItem() Get add method information.
String	getAddMethodName() Get add method name.
IClass	getChildObjectType() Get class passed to child components.
IClass	getItemTypeClass() Get item type information.
String	getItemTypeName() Get item type name.
IClassItem	getIterMethodItem() Get iterator method information.
String	getIterMethodName() Get iterator method name.
IClassItem	getLoadMethodItem() Get load method information.
String	getLoadMethodName() Get load method name.
IClassItem	getSizeMethodItem() Get size method information.
String	getSizeMethodName() Get size method name.
IClassItem	getStoreMethodItem() Get store method information.
String	getStoreMethodName() Get store method name.
boolean	hasAttribute() Check for attribute definition.
boolean	hasContent() Check for content definition.
boolean	hasObject() Check for object present.
void	prevalidate(ValidationContext vctx) Prevalidate element information.
void	setAddMethodName(String name) Set add method name.
boolean	setIdChild(IComponent child) Set ID property.
void	setItemTypeName(String type) Set item type name.
void	setIterMethodName(String name) Set iterator method name.
void	setLoadMethodName(String name) Set load method name.
void	setSizeMethodName(String name) Set size method name.
void	setStoreMethodName(String name) Set store method name.
void	validate(ValidationContext vctx) Validate element information.

Methods inherited from class org.jibx.binding.model.StructureElementBase

getDeclaredType, getField, getFieldName, getFlag, getGet, getGetName, getGetType, getName, getNamespace, getObjectType, getPrefix, getSet, getSetName, getSetType, getTest, getTestName, getType, getUri, getUsage, getUsageName, hasName, hasProperty, isFlagOnly, isImplicit, isOptional, setDeclaredType, setFieldName, setFlagName, setGetName, setName, setPrefix, setSetName, setTestName, setUri, setUsage, setUsageName

Methods inherited from class org.jibx.binding.model.ContainerElementBase

checkCompatibleChildren, classifyComponents, getAttributeComponents, getContentComponents, getCreateClass, getCreateType, getFactory, getFactoryName, getId, getLabel, getMarshaller, getMarshallerName, getPostset, getPostsetName, getPreget, getPregetName, getPreset, getPresetName, getUnmarshaller, getUnmarshallerName, getUsing, isAllowRepeats, isChoice, isClassified, isFlexible, isNillable, isOrdered, setAllowRepeats, setChoice, setComponents, setCreateType, setFactoryName, setFlexible, setIdChild, setLabel, setMarshallerName, setNillable, setOrdered, setPostsetName, setPregetName, setPresetName, setUnmarshallerName, setUsing, verifyConstruction

Methods inherited from class org.jibx.binding.model.NestingElementBase

addChild, childIterator, children, getDefaultStyle, getDefinitions, getStyle, getStyleName, setStyleName

Methods inherited from class org.jibx.binding.model.ElementBase

getComment, name, setComment, toString, type, validateAttributes

Methods inherited from class java.lang.Object

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

Field Detail

s_allowedAttributes

public static final StringArray s_allowedAttributes

Enumeration of allowed attribute names

Constructor Detail

CollectionElement

public CollectionElement()

Default constructor.

Method Detail

getItemTypeName

public String getItemTypeName()

Get item type name.

Returns:

item type name (or null if none)

setItemTypeName

public void setItemTypeName(String type)

Set item type name.

Parameters:

type - item type name (or null if none)

getItemTypeClass

public IClass getItemTypeClass()

Get item type information. This call is only meaningful after validation.

Returns:

item type information

getAddMethodName

public String getAddMethodName()

Get add method name.

Returns:

add method name (or null if none)

setAddMethodName

public void setAddMethodName(String name)

Set add method name.

Parameters:

name - add method name (or null if none)

getAddMethodItem

public IClassItem getAddMethodItem()

Get add method information. This call is only meaningful after validation.

Returns:

add method information (or null if none)

getIterMethodName

public String getIterMethodName()

Get iterator method name.

Returns:

iterator method name (or null if none)

setIterMethodName

public void setIterMethodName(String name)

Set iterator method name.

Parameters:

name - iterator method name (or null if none)

getIterMethodItem

public IClassItem getIterMethodItem()

Get iterator method information. This call is only meaningful after validation.

Returns:

iterator method information (or null if none)

getLoadMethodName

public String getLoadMethodName()

Get load method name.

Returns:

load method name (or null if none)

setLoadMethodName

public void setLoadMethodName(String name)

Set load method name.

Parameters:

name - load method name (or null if none)

getLoadMethodItem

public IClassItem getLoadMethodItem()

Get load method information. This call is only meaningful after validation.

Returns:

load method information (or null if none)

getSizeMethodName

public String getSizeMethodName()

Get size method name.

Returns:

size method name (or null if none)

setSizeMethodName

public void setSizeMethodName(String name)

Set size method name.

Parameters:

name - size method name (or null if none)

getSizeMethodItem

public IClassItem getSizeMethodItem()

Get size method information. This call is only meaningful after validation.

Returns:

size method information (or null if none)

getStoreMethodName

public String getStoreMethodName()

Get store method name.

Returns:

store method name (or null if none)

setStoreMethodName

public void setStoreMethodName(String name)

Set store method name.

Parameters:

name - store method name (or null if none)

getStoreMethodItem

public IClassItem getStoreMethodItem()

Get store method information. This call is only meaningful after validation.

Returns:

store method information (or null if none)

setIdChild

public boolean setIdChild(IComponent child)

Set ID property. This is never supported for an object coming from a collection.

Parameters:

child - child defining the ID property

Returns:

true if successful, false if ID already defined

hasObject

public boolean hasObject()

Check for object present. Always true for collection.

Overrides:

hasObject in class StructureElementBase

Returns:

true

hasAttribute

public boolean hasAttribute()

Check for attribute definition. Always false for collection.

Specified by:

hasAttribute in interface IComponent

Overrides:

hasAttribute in class StructureElementBase

Returns:

false

hasContent

public boolean hasContent()

Check for content definition. Always true for collection.

Specified by:

hasContent in interface IComponent

Overrides:

hasContent in class StructureElementBase

Returns:

true

getChildObjectType

public IClass getChildObjectType()

Description copied from class: ContainerElementBase

Get class passed to child components. This call is only meaningful after validation.

Overrides:

getChildObjectType in class ContainerElementBase

Returns:

information for class linked by binding

prevalidate

public void prevalidate(ValidationContext vctx)

Description copied from class: ElementBase

Prevalidate element information. The prevalidation step is used to check isolated aspects of an element, such as the settings for enumerated values on the element and attributes. This empty base class implementation should be overridden by each subclass that requires prevalidation handling.

Overrides:

prevalidate in class StructureElementBase

Parameters:

vctx - validation context

validate

public void validate(ValidationContext vctx)

Description copied from class: ElementBase

Validate element information. The validation step is used for checking the interactions between elements, such as name references to other elements. The ElementBase.prevalidate(org.jibx.binding.model.ValidationContext) method will always be called for every element in the binding definition before this method is called for any element. This empty base class implementation should be overridden by each subclass that requires validation handling.

Overrides:

validate in class StructureElementBase

Parameters:

vctx - validation context