Package org.jibx.binding.model

Class 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

    • 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

      • 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