com.jaxfront.core.type
Interface CompositeType

All Superinterfaces:
Type
All Known Implementing Classes:
AbstractCompositeType, ComplexGroup, DummyXPathRootType, SimpleGroup, XPathDummyChoiceTypeWrapper

public interface CompositeType
extends Type

This interface defines a JAXFront Composite Type . A Composite Types manages a list of other types which can be either of the types ComplexGroup, SimpleGroup or SimpleType.

Version:
1.60

Field Summary
 
Fields inherited from interface com.jaxfront.core.type.Type
ComplexGroup, ComplexGroupList, CompositeType, DummyType, EmptyType, GroupType, ListType, NONE, SimpleGroup, SimpleGroupList, SimpleType, SimpleTypeList, VirtualType
 
Method Summary
 void completeRecursion()
          Creates a recursion of a schema element and returns a type that holds the types created during the recursion.
 void createChoices()
          Lazy creates all choice axis.
 Type createChoiceType(java.lang.String name)
          Lazy creation of a choice type.
 java.util.List getAttributes()
          Returns all its attributes.
 java.util.Set getChoiceNames()
          In case of a choice, this will returns the choice names.
 java.util.List getComposites()
           
 SimpleType getContentType()
          Gets a type that has simple content.
 EmptyType getEmptyType()
          Gets an empty type if this is a an optional choice.
 Type getParentEditingTypeForName(java.lang.String choiceName)
          Walks back up to the last list type holding the whole structure of this composite type.
 java.lang.String[] getRelevantChoiceNames()
          Returns an array of names of all direct choic options.
 java.util.List getRelevantChoiceTypes()
          Gets a list of all relevant choice types already created and without attribute types.
 boolean hasAttributes()
          Returns true if this composite holds any attributes.
 boolean hasEmptyContent(boolean checkSerializeDefaults, boolean checkDefaultValue)
          Returns if any of the composite types has empty content.
 boolean hasOnlySimpleTypes()
          Returns true if all my children are simple types.
 void removeChoices()
          Removes the selected choosen type.
 
Methods inherited from interface com.jaxfront.core.type.Type
addTreeNode, bind, bind, bind, bind, deepClone, deepClone, getChild, getChild, getChoosenType, getClientProperty, getDerivedTypes, getDirectChild, getDirectChild, getDirectChildren, getDirectChildren, getDirectChildValue, getDisplayValue, getDOM, getFullCaption, getFullCaption, getId, getMixedContent, getName, getNamespace, getNextSibling, getParent, getParent, getParentList, getPrefixedXPathLocation, getPreviousSibling, getPropertyChangeSupport, getQName, getRepresentedTableLayoutParent, getRepresentedTabParent, getRepresentedTreeNodeHolder, getRepresentedTreeNodeParent, getRepresentedTreeNodeParentIcon, getRepresentedTreeNodeParentIconName, getSchemaElement, getSchemaType, getSerializationName, getShortCaption, getStyle, getTemplate, getTreeHierarchyContext, getTypeClassification, getUserObject, getVisualName, getW3CXPathLocation, getXPathLocation, getXUIDefinition, getXUIDefinition, hasChoosenType, hasRecursionBeenBuilt, hasRepresentableTreeChildren, hasUIDefinition, hasUnChoosenChoiceParent, hasUndefinedChildren, hasValidationError, isAbstract, isAnonymous, isAttribute, isChoice, isComposite, isDerived, isDerivedFrom, isDerivedFromEditingType, isEditingType, isEmpty, isGlobal, isIncluded, isKey, isKeyContext, isKeyRef, isList, isLocked, isRecursive, isReleased, isRenderable, isRepresentedAsHeader, isRepresentedAsTab, isRepresentedAsTreeNode, isRequired, isRoot, isSerializable, isSerializable, isSimple, isUserInstanciated, isVirtual, markAsDirtyXPath, putClientProperty, release, remove, removeAll, removeChild, removeClientProperty, removeMessage, removeTreeNode, serialize, serialize, setApplicationRequired, setBackground, setChoosenType, setChoosenType, setCodeSetValues, setDirectChildValue, setDOM, setEditable, setEnabled, setForeground, setId, setIsKeyContext, setLabelColor, setLabelText, setParent, setRenderable, setSchemaElement, setSerializable, setSerializable, setTemplate, setTreeIcon, setUIDefinition, setUserInstanciated, setUserObject, setVisible, setVisibleAndSerializable, showLabel, showMessage, unChoosenBranch
 

Method Detail

getComposites

java.util.List getComposites()

hasEmptyContent

boolean hasEmptyContent(boolean checkSerializeDefaults,
                        boolean checkDefaultValue)
Returns if any of the composite types has empty content.

Returns:
true, if any of the composite types has empty content, false otherwise

getChoiceNames

java.util.Set getChoiceNames()
In case of a choice, this will returns the choice names. Also nested unnamed choices will be considered.


getRelevantChoiceNames

java.lang.String[] getRelevantChoiceNames()
Returns an array of names of all direct choic options.


getEmptyType

EmptyType getEmptyType()
Gets an empty type if this is a an optional choice.

Returns:
an empty type or null

removeChoices

void removeChoices()
                   throws ListModificationException
Removes the selected choosen type.

Throws:
ListModificationException

completeRecursion

void completeRecursion()
                       throws java.lang.CloneNotSupportedException
Creates a recursion of a schema element and returns a type that holds the types created during the recursion.

Parameters:
recursiveStartElement - the element with which the recursion begins
Throws:
java.lang.CloneNotSupportedException

getContentType

SimpleType getContentType()
Gets a type that has simple content.

Returns:
a type that has simple content

createChoiceType

Type createChoiceType(java.lang.String name)
Lazy creation of a choice type.

Parameters:
name - of the choice type.

getAttributes

java.util.List getAttributes()
Returns all its attributes.


getParentEditingTypeForName

Type getParentEditingTypeForName(java.lang.String choiceName)
Walks back up to the last list type holding the whole structure of this composite type. Returns the choice type for a given name hold by the editing type axis.


getRelevantChoiceTypes

java.util.List getRelevantChoiceTypes()
Gets a list of all relevant choice types already created and without attribute types.


hasOnlySimpleTypes

boolean hasOnlySimpleTypes()
Returns true if all my children are simple types.


hasAttributes

boolean hasAttributes()
Returns true if this composite holds any attributes.


createChoices

void createChoices()
Lazy creates all choice axis.