org.jibx.binding.def
Class NestedCollection

java.lang.Object
  extended byorg.jibx.binding.def.BindingBuilder.ContainerBase
      extended byorg.jibx.binding.def.NestedBase
          extended byorg.jibx.binding.def.NestedCollection
All Implemented Interfaces:
IComponent, IContainer

public class NestedCollection
extends NestedBase

Collection binding definition. This handles one or more child components, which may be ordered or unordered.

Version:
1.0
Author:
Dennis M. Sosnoski

Nested Class Summary
(package private) static class NestedCollection.AddStore
          Collection item store strategy for collection with add method.
(package private) static class NestedCollection.ArrayLoad
          Collection item load strategy for array.
(package private) static class NestedCollection.ArrayStore
          Collection item store strategy for array.
(package private) static class NestedCollection.CollectionBase
          Base class for collection item load strategy.
(package private) static class NestedCollection.CollectionLoad
          Base class for collection item load strategy.
(package private) static class NestedCollection.CollectionStore
          Base class for collection item store strategy.
(package private) static class NestedCollection.IndexedLoad
          Collection item load strategy for collection with items accessed by index number.
(package private) static class NestedCollection.IndexedStore
          Collection item store strategy for collection with items set by index number.
(package private) static class NestedCollection.IteratorLoad
          Collection item load strategy for collection with items accessed by iterator or enumeration.
 
Field Summary
private static java.lang.String CHECK_ISSTART_NAME
           
private static java.lang.String CHECK_ISSTART_SIGNATURE
           
private static java.lang.String GROWARRAY_METHOD
           
private static java.lang.String GROWARRAY_SIGNATURE
           
private  boolean m_isOptional
          Optional component flag.
private  java.lang.String m_itemType
          Fully qualified class name of values from collection.
private  NestedCollection.CollectionLoad m_loadStrategy
          Strategy for generating code to load item from collection.
private  NestedCollection.CollectionStore m_storeStrategy
          Strategy for generating code to store item to collection.
private static java.lang.String RESIZEARRAY_METHOD
           
private static java.lang.String RESIZEARRAY_SIGNATURE
           
private static java.lang.String SKIP_ELEMENT_NAME
           
private static java.lang.String SKIP_ELEMENT_SIGNATURE
           
 
Fields inherited from class org.jibx.binding.def.NestedBase
m_accessLevel, m_attributes, m_autoLink, m_container, m_contents, m_isFlexible, m_isOrdered, m_nameStyle, m_stripPrefix, m_stripSuffix, m_styleDefault
 
Constructor Summary
NestedCollection(IContainer parent, IContextObj objc, boolean ord, boolean opt, boolean flex, java.lang.String type, NestedCollection.CollectionLoad load, NestedCollection.CollectionStore store)
          Constructor.
 
Method Summary
 void genAttributeMarshal(ContextMethodBuilder mb)
          Generate attribute marshalling code.
 void genAttributeUnmarshal(ContextMethodBuilder mb)
          Generate attribute unmarshalling code.
 void genAttrPresentTest(ContextMethodBuilder mb)
          Generate code to test for attribute present.
 void genContentMarshal(ContextMethodBuilder mb)
          Generate element or text marshalling code.
 void genContentUnmarshal(ContextMethodBuilder mb)
          Generate element or text unmarshalling code.
 void genLoadId(ContextMethodBuilder mb)
          Generate code to load ID value of instance to stack.
 java.lang.String getItemType()
          Get the collection item type.
 NameDefinition getWrapperName()
          Get element wrapper name.
 boolean hasAttribute()
          Check if component defines one or more attribute values of the containing element.
 boolean hasContent()
          Check if component defines one or more elements or text values as children of the containing element.
 boolean hasId()
          Check if component defines an ID value for instances of context object.
 boolean isOptional()
          Check if component is an optional item.
 void print(int depth)
           
 void setLinkages()
          Establish and validate linkages between binding components.
 
Methods inherited from class org.jibx.binding.def.NestedBase
addComponent, genContentPresentTest, genNewInstance, getAttributes, getBindingRoot, getContents, getDefinitionContext, getStyleDefault, getType, hasNamespaces, isContentOrdered, isFlexible, setObjectContext, unmarshal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jibx.binding.def.IContainer
getStyleDefault
 

Field Detail

GROWARRAY_METHOD

private static final java.lang.String GROWARRAY_METHOD
See Also:
Constant Field Values

GROWARRAY_SIGNATURE

private static final java.lang.String GROWARRAY_SIGNATURE
See Also:
Constant Field Values

RESIZEARRAY_METHOD

private static final java.lang.String RESIZEARRAY_METHOD
See Also:
Constant Field Values

RESIZEARRAY_SIGNATURE

private static final java.lang.String RESIZEARRAY_SIGNATURE
See Also:
Constant Field Values

CHECK_ISSTART_NAME

private static final java.lang.String CHECK_ISSTART_NAME
See Also:
Constant Field Values

CHECK_ISSTART_SIGNATURE

private static final java.lang.String CHECK_ISSTART_SIGNATURE
See Also:
Constant Field Values

SKIP_ELEMENT_NAME

private static final java.lang.String SKIP_ELEMENT_NAME
See Also:
Constant Field Values

SKIP_ELEMENT_SIGNATURE

private static final java.lang.String SKIP_ELEMENT_SIGNATURE
See Also:
Constant Field Values

m_itemType

private final java.lang.String m_itemType
Fully qualified class name of values from collection.


m_loadStrategy

private final NestedCollection.CollectionLoad m_loadStrategy
Strategy for generating code to load item from collection.


m_storeStrategy

private final NestedCollection.CollectionStore m_storeStrategy
Strategy for generating code to store item to collection.


m_isOptional

private final boolean m_isOptional
Optional component flag.

Constructor Detail

NestedCollection

public NestedCollection(IContainer parent,
                        IContextObj objc,
                        boolean ord,
                        boolean opt,
                        boolean flex,
                        java.lang.String type,
                        NestedCollection.CollectionLoad load,
                        NestedCollection.CollectionStore store)
Constructor.

Parameters:
parent - containing binding definition context
objc - current object context
ord - ordered content flag
opt - optional component flag
flex - flexible element handling flag
type - fully qualified class name of values from collection (may be null, if child content present)
load - collection load code generation strategy
store - collection store code generation strategy
Method Detail

getItemType

public java.lang.String getItemType()
Get the collection item type.

Returns:
item type

hasAttribute

public boolean hasAttribute()
Description copied from interface: IComponent
Check if component defines one or more attribute values of the containing element.

Returns:
true if one or more attribute values defined for containing element, false if not

genAttrPresentTest

public void genAttrPresentTest(ContextMethodBuilder mb)
Description copied from interface: IComponent
Generate code to test for attribute present. This generates code that tests if a child is present as determined by attributes of the containing start tag. It leaves the result of the test (zero if missing, nonzero if present) on the stack. This call is only valid if this component has one or more attributes for the containing element.

Parameters:
mb - method builder

genAttributeUnmarshal

public void genAttributeUnmarshal(ContextMethodBuilder mb)
Description copied from interface: IComponent
Generate attribute unmarshalling code. This is called within the code generation for the unmarshaller of the class associated with the containing element. It needs to generate the necessary code for handling the unmarshalling operation, leaving the unmarshalled object reference on the stack.

Parameters:
mb - method builder

genAttributeMarshal

public void genAttributeMarshal(ContextMethodBuilder mb)
Description copied from interface: IComponent
Generate attribute marshalling code. This is called within the code generation for the marshaller of the class associated with the containing element. It needs to generate the necessary code for handling the marshalling operation, consuming the marshalled object reference from the stack.

Parameters:
mb - method builder

hasContent

public boolean hasContent()
Description copied from interface: IComponent
Check if component defines one or more elements or text values as children of the containing element. This method is only valid after the call to IComponent.setLinkages().

Specified by:
hasContent in interface IComponent
Overrides:
hasContent in class NestedBase

genContentUnmarshal

public void genContentUnmarshal(ContextMethodBuilder mb)
                         throws JiBXException
Description copied from interface: IComponent
Generate element or text unmarshalling code. This is called within the code generation for the unmarshaller of the class associated with the containing element. It needs to generate the necessary code for handling the unmarshalling operation, leaving the unmarshalled object reference on the stack.

Parameters:
mb - method builder
Throws:
JiBXException - if error in configuration

genContentMarshal

public void genContentMarshal(ContextMethodBuilder mb)
                       throws JiBXException
Description copied from interface: IComponent
Generate element or text marshalling code. This is called within the code generation for the marshaller of the class associated with the containing element. It needs to generate the necessary code for handling the marshalling operation, consuming the marshalled object reference from the stack.

Parameters:
mb - method builder
Throws:
JiBXException - if error in configuration

hasId

public boolean hasId()
Description copied from interface: IComponent
Check if component defines an ID value for instances of context object.

Returns:
true if ID value defined for instances, false if not

genLoadId

public void genLoadId(ContextMethodBuilder mb)
               throws JiBXException
Description copied from interface: IComponent
Generate code to load ID value of instance to stack. The generated code should assume that the top of the stack is the reference for the containing object. It must consume this and leave the actual ID value on the stack (as a String).

Parameters:
mb - method builder
Throws:
JiBXException - if configuration error

getWrapperName

public NameDefinition getWrapperName()
Description copied from interface: IComponent
Get element wrapper name. If the component defines an element as the container for content, this returns the name information for that element.

Specified by:
getWrapperName in interface IComponent
Overrides:
getWrapperName in class NestedBase

isOptional

public boolean isOptional()
Description copied from interface: IComponent
Check if component is an optional item.

Specified by:
isOptional in interface IComponent
Overrides:
isOptional in class NestedBase

setLinkages

public void setLinkages()
                 throws JiBXException
Description copied from interface: IComponent
Establish and validate linkages between binding components. This is called after the basic binding structures have been set up. All linkages between components must be resolved by this method, in order to prevent problems due to the order of definitions between components. This implies that each component must in turn call the same method for each child component. None of the other method calls defined by this interface are valid until after this call.

Throws:
JiBXException - if error in configuration

print

public void print(int depth)


Project Web Site