com.jaxfront.core.xpath
Class XPathDummyChoiceTypeWrapper

java.lang.Object
  extended by com.jaxfront.core.xpath.XPathDummyChoiceTypeWrapper
All Implemented Interfaces:
CompositeType, ListType, Type, java.lang.Iterable, java.util.Collection, java.util.List

public class XPathDummyChoiceTypeWrapper
extends java.lang.Object
implements Type, CompositeType, ListType


Field Summary
 
Fields inherited from interface com.jaxfront.core.type.Type
ComplexGroup, ComplexGroupList, CompositeType, DummyType, EmptyType, GroupType, ListType, NONE, SimpleGroup, SimpleGroupList, SimpleType, SimpleTypeList, VirtualType
 
Fields inherited from interface com.jaxfront.core.type.Type
ComplexGroup, ComplexGroupList, CompositeType, DummyType, EmptyType, GroupType, ListType, NONE, SimpleGroup, SimpleGroupList, SimpleType, SimpleTypeList, VirtualType
 
Fields inherited from interface com.jaxfront.core.type.ListType
VALIDATE_ADD, VALIDATE_DELETE, VALIDATE_NOCHANGE
 
Fields inherited from interface com.jaxfront.core.type.Type
ComplexGroup, ComplexGroupList, CompositeType, DummyType, EmptyType, GroupType, ListType, NONE, SimpleGroup, SimpleGroupList, SimpleType, SimpleTypeList, VirtualType
 
Constructor Summary
XPathDummyChoiceTypeWrapper(CompositeType choiceHolderType, SchemaNode aSchemaNode)
           
 
Method Summary
 void add(int arg0, java.lang.Object arg1)
           
 boolean add(java.lang.Object arg0)
           
 Type add(Type type)
          Adds a new type to the list.
 boolean addAll(java.util.Collection arg0)
           
 boolean addAll(int arg0, java.util.Collection arg1)
           
 Type addNewChild()
          Adds a new child to the list.
 Type addNewChild(int index)
           
 Type addNewChild(Type template)
          Adds a new child to the list.
 Type addNewChild(Type templateType, int targetIndex)
          Copies the given templateType and adds it to the list at the given index position.
 void addNoTargetXUIDefinition(Type xuiType)
          Adds an information to a XUI type if a list doesn't contain any types for which a XUI definition would exist.
 void addTreeNode(boolean shouldBeSerialized)
          Adds this type to the tree.
 void autoCreateEntries()
          Create the initial number of required min occur list items.
 void bind(Document DOM, org.w3c.dom.Element element)
          Binds the values on a W3C element to the underlying JAXFront type.
 void bind(Document DOM, org.w3c.dom.Element element, boolean bindOnlyAvailable)
          Binds the values on a W3C element to the underlying JAXFront type.
 void bind(Document DOM, org.w3c.dom.Element instanceElement, boolean bindOnlyAvailable, boolean removeChilds)
           
 void bind(java.lang.Object trigger, Type type)
          Binds the values of an JAXFront type to myself.
 void bind(Type type)
          Binds the values of an JAXFront type to myself.
 void checkCardinality(int changes)
          Checks if removing or adding a new list entry violates the cardinality.
 void clear()
           
 void completeRecursion()
          Creates a recursion of a schema element and returns a type that holds the types created during the recursion.
 boolean contains(java.lang.Object o)
           
 boolean containsAll(java.util.Collection arg0)
           
 void copyAndPasteChild(java.lang.Integer typeToCopyIndex, java.lang.Integer targetIndex)
           
 void copyAndPasteChild(Type typeToCopy)
           
 void copyAndPasteChild(Type typeToCopy, java.lang.Integer targetIndex)
           
 Type copyChild(java.lang.Integer index)
          Copies the child with the given index and returns it.
 void createChoices()
          Lazy creates all choice axis.
 Type createChoiceType(java.lang.String name)
          Lazy creation of a choice type.
 Type deepClone(Document dom, boolean cloneChoices, boolean includingData)
          Creates a deep clone of this type and all its referenced types.
 Type deepClone(Document dom, boolean cloneChoices, boolean includingData, boolean includeEditingType, SchemaNode schemaNode, org.w3c.dom.Element element)
          Creates a deep clone of this type and all its referenced types.
 java.lang.Object delete(Type type)
          Deletes a type from the list.
 java.lang.Object get(int index)
           
 java.util.List getAttributes()
          Returns all its attributes.
 Type getChild(java.lang.String name)
          Gets a child (recursive) type with a given name
 Type getChild(java.lang.String name, java.lang.String nameSpace)
          Gets a child (recursive) type with a given name
 java.util.Set getChoiceNames()
          In case of a choice, this will returns the choice names.
 Type getChoosenType()
          Gets the choosen type if this type is a choice element.
 java.lang.Object getClientProperty(java.lang.String key)
          Gets a client property for this type.
 java.util.List getComposites()
           
 SimpleType getContentType()
          Gets a type that has simple content.
 java.util.List getDerivedTypes()
          Gets a list of all derived types if this type is an abstract type.
 Type getDirectChild(java.lang.String name)
          Gets a direct child (next axis) type with a given name
 Type getDirectChild(java.lang.String name, java.lang.String namespace)
          Gets a direct child (next axis) type with a given name
 java.util.List getDirectChildren()
          Gets a list of all child types.
 java.util.List getDirectChildren(java.lang.String name)
          Gets a list of child types with a given name.
 java.lang.String getDirectChildValue(java.lang.String name)
          Gets the value of a child type with a given name.
 java.lang.String getDisplayValue()
          Returns this type as a String representation.
 Document getDOM()
          Gets the current JAXFront document (DOM).
 Type getEditingType()
          Gets the current editable type of the list.
 EmptyType getEmptyType()
          Gets an empty type if this is a an optional choice.
 java.lang.String getFullCaption()
          Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent.
 java.lang.String getFullCaption(int labelLength)
          Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent.
 short[] getId()
          Gets a unique ID within the current JAXFront documennt (DOM) expressing axis position.
 java.util.List getList()
          Gets the list of types.
 int getMaxOccurs()
          Returns the maximum number of allowed list entries.
 int getMinOccurs()
          Returns the minimum number of allowed list entries.
 Type getMixedContent()
          Returns the mixed content leaf type or null if none.
 java.lang.String getName()
          Returns the name witout namespace previx.
 java.lang.String getNamespace()
          Gets the namespace name of the underlying W3C DOM.
 Type getNextSibling()
          Returns the next sibling type of the current type.
 Type getParent()
          Gets the parent type of the current type.
 Type getParent(java.lang.String parentName)
          Gets the parent type with the given name.
 Type getParentEditingTypeForName(java.lang.String choiceName)
          Walks back up to the last list type holding the whole structure of this composite type.
 ListType getParentList()
          Gets the parent list type of the current type.
 java.lang.String getPrefixedXPathLocation()
          Gets the prefixed xpath location of the current type.
 Type getPreviousSibling()
          Returns the previous sibling type of the current type.
 java.beans.PropertyChangeSupport getPropertyChangeSupport()
          Gets the PropertyChangeSupport helper instance for this type.
 java.lang.String getQName()
          Gets the tag name including namespace prefix.
 Type getRealType()
           
 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.
 Type getRepresentedTableLayoutParent()
          Returns the type (one of my parents) which defines a tableLayout which represents this type or null.
 Type getRepresentedTabParent(boolean checkCurrentType)
          Gets the holding tree parent type that is represented as tab.
 Type getRepresentedTreeNodeHolder()
          Gets the holding tree parent type in the navigation tree, where the view holder is self.
 Type getRepresentedTreeNodeParent()
          Gets the holding tree parent type in the navigation tree.
 javax.swing.ImageIcon getRepresentedTreeNodeParentIcon()
          Returns the uppermost icon that can be found of the tree node parents of the current type.
 java.lang.String getRepresentedTreeNodeParentIconName()
          Returns the name of the uppermost icon that can be found of the tree node parents of the current type.
 SchemaNode getSchemaElement()
          Gets the meta information schema element.
 SchemaType getSchemaType()
           
 java.lang.String getSerializationName()
           
 java.lang.String getShortCaption()
          Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent.
 int[] getSortIndexes()
          Returns the sort indexes or null.
 StyleDefinition getStyle()
           
 Type getTemplate()
           
 java.lang.String getTreeHierarchyContext()
          Returns the treeEntry hierarchy of the current type as coma separated String (context).
 short getTypeClassification()
          Returns the type classification.
 java.lang.Object getUserObject()
          Gets any user object set to this type.
 java.lang.String getVisualName()
          Returns the visual name of this type.
 java.lang.String getW3CXPathLocation(boolean prefixed)
          Gets the W3C xpath location of the current type.This method returns the xpath without internal created unnamed elements!
 java.lang.String getXPathLocation()
          Gets the xpath location of the current type.
 XUIDefinition getXUIDefinition()
          Gets the current XUI definition.
 XUIDefinition getXUIDefinition(boolean create)
          Gets the current XUI definition saying if a xui definition should be initialized lazy if it does not exist.
 boolean hasAttributes()
          Returns true if this composite holds any attributes.
 boolean hasChoosenType()
           
 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.
 boolean hasRecursionBeenBuilt()
          Returns true if type is a recursion holder and recursive start element has been created yet.
 boolean hasRepresentableTreeChildren()
          Returns true if this type has any child types represented in the navigation tree.
 boolean hasUIDefinition()
          Returns true if the uiDefinition is alredy set.
 boolean hasUnChoosenChoiceParent()
          Returns true if this type has an unchoosen choice parent, false otherwise
 boolean hasUndefinedChildren()
          Returns true it this type holds a direct optional child.
 boolean hasValidationError()
          Returns true if an validation error exists for this type.
 int indexOf(java.lang.Object o)
           
 boolean isAbstract()
          Returns true if this type is defined abstract in the schema element.
 boolean isAnonymous()
          Returns true if this type has no tag element (unnamed holder).
 boolean isAttribute()
          Returns true if this type is defined as an attribute in the XML schema.
 boolean isChoice()
          Returns true if this type is acting as a choice.
 boolean isComposite()
          Returns true if this type consists of other types.
 boolean isDerived()
          Returns true if this type is implementing an abstract type.
 boolean isDerivedFrom(Type type)
          Returns true if this type is a child of a given type.
 boolean isDerivedFromEditingType()
          Returns true if this type is derived from an editing type.
 boolean isEditingType()
          Returns true if my parent is a list and this type is a template for further addings.
 boolean isEmpty()
          Returns true if this type is not represented in the target JAXFront DOM.
 boolean isGlobal()
          Return true it this type is global.
 boolean isIncluded()
          Returns true if this type was included from an included xui file.
 boolean isKey()
          Returns true if this type is a key selector.
 boolean isKeyContext()
          Returns true if this type is a key context used in KeyKeyRefManager.
 boolean isKeyRef()
          Returns true if this type is a key ref selector.
 boolean isList()
          Returns true if this type represents a list.
 boolean isListItemRemoveable(Type type)
           
 boolean isLocked()
          Returns true if this type is locked via document.lock().
 boolean isRecursive()
          Returns true if this type is starting a new recursion.
 boolean isReleased()
           
 boolean isRenderable()
          Returns true if the type is included into the rendering process.
 boolean isRepresentedAsHeader()
          Returns true if this type has a header.
 boolean isRepresentedAsTab()
          Returns true if this type is represented as tab.
 boolean isRepresentedAsTreeNode()
          Returns true if this type is represented in the navigation tree.
 boolean isRequired()
          Returns true if this type is defined mandatory in the xml schema.
 boolean isRoot()
          Returns true if this type is the root of the JAXFront DOM.
 boolean isSerializable()
          Returns true if this type should be serialized in the resulting W3C DOM.
 boolean isSerializable(boolean checkValue)
          Returns true if this type should be serialized in the resulting W3C DOM.
 boolean isSimple()
          Returns true if this is a leaf in the tree.
 boolean isUserInstanciated()
           
 boolean isVirtual()
          Returns true if this type is implementing an virtual type.
 java.util.Iterator iterator()
           
 int lastIndexOf(java.lang.Object o)
           
 java.util.ListIterator listIterator()
           
 java.util.ListIterator listIterator(int index)
           
 void maintainXUIDefinitions(Type type)
          Traverses down the editing type and maintains all the xui definitions set on the editing type axis to the passed type.
 void markAsDirtyXPath()
          Marks an xpath as dirty.
 void move(int from, int to)
          Moves the type from position "from" to position "to", shifting the other elements
 void putClientProperty(java.lang.String key, java.lang.Object object)
           
 void release()
          Release all allocated resources for this type.
 boolean remove()
          Removes this type from the JAXFront DOM.
 java.lang.Object remove(int index)
           
 boolean remove(java.lang.Object o)
           
 void removeAll()
          Removes all types from this type.
 void removeAll(boolean isTemporary, boolean checkCardinality)
          Removes all childs of the list.
 boolean removeAll(java.util.Collection arg0)
           
 java.lang.Object removeChild(int index)
          Removes the list item with the given index from the list.
 boolean removeChild(Type child)
          Removes a child from the JAXFront DOM.
 void removeChoices()
          Removes the selected choosen type.
 void removeClientProperty(java.lang.String key)
           
 java.lang.Object removeLastChild(boolean temporary)
          Removes the last list item from the list.
 void removeMessage()
          Removes all validation error messages for this type.
 void removeNoTargetXUIDefinition(Type xuiType)
          Removes an information of a XUI type if a list doesn't contain any types for which a XUI definition would exist.
 void removeTreeNode(boolean shouldBeSerialized)
          Removes this type from the tree.
 boolean retainAll(java.util.Collection arg0)
           
 java.lang.StringBuffer serialize()
          Serializes the current subTree to a StringBuffer
 void serialize(java.lang.StringBuffer sb, int indent, boolean writeName, boolean recursive)
          Serializes the current subTree to a StringBuffer
 java.lang.Object set(int arg0, java.lang.Object arg1)
           
 void setApplicationRequired(boolean required)
          Sets if an user input is required for this type or not (overwrites xml schema cardinality).
 void setBackground(java.awt.Color color)
           
 void setChoosenType(Type choosenType)
          Sets the choosen type if this type is a choice.
 void setChoosenType(Type choosenType, boolean temporary)
          Sets the choosen type if this type is a choice.
 void setCodeSetValues(java.lang.String url, java.lang.String codeSetName, java.lang.String[] values, java.lang.String defaultSelection)
          Sets the codeSet values for the current type.
 void setDirectChildValue(java.lang.String childName, java.lang.String value)
          Sets the value of a child type of this type.
 void setDOM(Document DOM)
          Sets a current JAXFront document (DOM).
 void setEditable(boolean editable)
          Sets the component editable or not editable.
 void setEditingType(Type editingType)
          Resets the editing type.
 void setEnabled(boolean enabled)
          Sets the component enabled (active) or disabled (inactive).
 void setForeground(java.awt.Color color)
           
 void setId(short[] id)
          Sets a unique ID within the current JAXFront documennt (DOM) expressing axis position.
 void setIsKeyContext(boolean isContext)
          Set true if this type is a key context!
 void setLabelColor(java.awt.Color color)
           
 void setLabelText(java.lang.String text)
           
 void setList(java.util.List list)
          Sets the list entries.
 void setParent(Type parent)
          Gets the parent type of the current type.
 void setRenderable(boolean renderable)
          Defines if the type should be included into the rendering process.
 void setSchemaElement(SchemaNode element)
          Sets the meta information schema element.
 void setSerializable(boolean isDefined)
          Sets if this type should be serialized in the resulting W3C DOM.
 void setSerializable(boolean isDefined, boolean checkForEmptyContent)
          Sets if this type should be serialized in the resulting W3C DOM which depends on the content of the type.
 void setSortIndexes(int[] sortIndexes)
          Set the sort indexes.
 void setTemplate(Type template)
           
 void setTreeIcon(java.lang.String gifName)
          Set the tree icon for this type.
 void setUIDefinition(XUIDefinition uiDefinition)
          Sets a XUI definition to this type.
 void setUserInstanciated(boolean userTriggered)
           
 void setUserObject(java.lang.Object object)
          Sets any user object to this type.
 void setVisible(boolean visible)
          Sets the visualizer of this type visible or invisible at runtime.
 void setVisibleAndSerializable(boolean visible, boolean isSerializable)
          Sets the component visible or invisible and defines if the data will be serialized or not.
 void showLabel(boolean visible)
          Sets the label visible or invisible.
 void showMessage(java.lang.String message, java.lang.String classification, boolean showDialog, boolean needsUserAcceptance)
          Dislplays a message for this type with the passed information.
 int size()
           
 java.util.List subList(int fromIndex, int toIndex)
           
 void swap(int from, int to)
          Swaps the position of two given types in the list
 java.lang.Object[] toArray()
           
 java.lang.Object[] toArray(java.lang.Object[] arg0)
           
 boolean unChoosenBranch()
           
 boolean violateCardinality(int changes)
          Checks if removing or adding a new list entry violates the cardinality.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.List
equals, hashCode
 

Constructor Detail

XPathDummyChoiceTypeWrapper

public XPathDummyChoiceTypeWrapper(CompositeType choiceHolderType,
                                   SchemaNode aSchemaNode)
Method Detail

addTreeNode

public void addTreeNode(boolean shouldBeSerialized)
Description copied from interface: Type
Adds this type to the tree.

Specified by:
addTreeNode in interface Type
Parameters:
shouldBeSerialized - defines if this type should be serialized

bind

public void bind(Document DOM,
                 org.w3c.dom.Element element)
Description copied from interface: Type
Binds the values on a W3C element to the underlying JAXFront type.

Specified by:
bind in interface Type
Parameters:
DOM - the current document to which this type belongs
element - the element to bind

bind

public void bind(Document DOM,
                 org.w3c.dom.Element element,
                 boolean bindOnlyAvailable)
Description copied from interface: Type
Binds the values on a W3C element to the underlying JAXFront type. Removes not available types if no W3C element has been found and the flag "bindOnlyAvailable" is set to true.

Specified by:
bind in interface Type
Parameters:
DOM - the current document to which this type belongs
element - the element to bind
bindOnlyAvailable - indicates if the not available elements will be removed from type tree

bind

public void bind(Type type)
Description copied from interface: Type
Binds the values of an JAXFront type to myself.

Specified by:
bind in interface Type
Parameters:
type - the type to bind to

bind

public void bind(java.lang.Object trigger,
                 Type type)
Description copied from interface: Type
Binds the values of an JAXFront type to myself.

Specified by:
bind in interface Type
Parameters:
trigger - trigger object e.g. Clipboard,Button used to identify user triggered actions
type - the type to bind to

deepClone

public Type deepClone(Document dom,
                      boolean cloneChoices,
                      boolean includingData)
               throws java.lang.CloneNotSupportedException
Description copied from interface: Type
Creates a deep clone of this type and all its referenced types.

Specified by:
deepClone in interface Type
Parameters:
dom - the current dom to which this type belongs
includingData - indicates if all binded data should be copied as well (default is false)
Returns:
the cloned type
Throws:
java.lang.CloneNotSupportedException

isRenderable

public boolean isRenderable()
Description copied from interface: Type
Returns true if the type is included into the rendering process. Note: If the type is not rendered it can't be make visible by an uiAction defined in a rule!

Specified by:
isRenderable in interface Type
See Also:
Type.isRenderable()

getRealType

public Type getRealType()

getChild

public Type getChild(java.lang.String name)
Description copied from interface: Type
Gets a child (recursive) type with a given name

Specified by:
getChild in interface Type
Parameters:
name - name of the child
Returns:
a child with the given name

getChild

public Type getChild(java.lang.String name,
                     java.lang.String nameSpace)
Description copied from interface: Type
Gets a child (recursive) type with a given name

Specified by:
getChild in interface Type
Parameters:
name - name of the child
Returns:
a child with the given name

getChoosenType

public Type getChoosenType()
Description copied from interface: Type
Gets the choosen type if this type is a choice element.

Specified by:
getChoosenType in interface Type
Returns:
the choosen type if this type is a choice, null otherwise

hasChoosenType

public boolean hasChoosenType()
Specified by:
hasChoosenType in interface Type

getClientProperty

public java.lang.Object getClientProperty(java.lang.String key)
Description copied from interface: Type
Gets a client property for this type.

Specified by:
getClientProperty in interface Type

getDOM

public Document getDOM()
Description copied from interface: Type
Gets the current JAXFront document (DOM).

Specified by:
getDOM in interface Type
Returns:
the current JAXFront document (DOM)

getDerivedTypes

public java.util.List getDerivedTypes()
Description copied from interface: Type
Gets a list of all derived types if this type is an abstract type.

Specified by:
getDerivedTypes in interface Type
Returns:
a list of all derived types if this type is an abstract type, null otherwise

getDirectChild

public Type getDirectChild(java.lang.String name)
Description copied from interface: Type
Gets a direct child (next axis) type with a given name

Specified by:
getDirectChild in interface Type
Parameters:
name - name of the child
Returns:
a child with the given name

getDirectChildValue

public java.lang.String getDirectChildValue(java.lang.String name)
Description copied from interface: Type
Gets the value of a child type with a given name.

Specified by:
getDirectChildValue in interface Type
Parameters:
name - the name of the child
Returns:
the value of a child type with a given name

getDirectChildren

public java.util.List getDirectChildren()
Description copied from interface: Type
Gets a list of all child types.

Specified by:
getDirectChildren in interface Type
Returns:
a list of all child types

getDirectChildren

public java.util.List getDirectChildren(java.lang.String name)
Description copied from interface: Type
Gets a list of child types with a given name.

Specified by:
getDirectChildren in interface Type
Parameters:
name - the name of the child(s)
Returns:
a list of child types with a given name

getDisplayValue

public java.lang.String getDisplayValue()
Description copied from interface: Type
Returns this type as a String representation.

Specified by:
getDisplayValue in interface Type
Returns:
this type as a String representation

getFullCaption

public java.lang.String getFullCaption()
Description copied from interface: Type
Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent. All parent types are checked (unlike getShortCaption()). The parent type that are represented as tree nodes will be listed with their nls treeEntry label. Each element caption will be cut by the global defined length and will get the string "...". The elements will be separated by the string " - ". For elements with cardinality n, the index within the list will be added at the end. If a schema key has been defined for an element, the key will be used as index for n, else the xpath-index will be applied. Example: /purchaseOrder/item[s]/item[1]/productDescription This would give following expression: purchaseOrder - item - item[1] - productDescription

Specified by:
getFullCaption in interface Type
Returns:
an nls translated (if any) xpath of a type up to its upper most represented tree node parent
See Also:
Type.getFullCaption(int)

getFullCaption

public java.lang.String getFullCaption(int labelLength)
Description copied from interface: Type
Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent. All parent types are checked (unlike getShortCaption()). The parent type that are represented as tree nodes will be listed with their nls treeEntry label. Each element caption will be cut by the global defined length and will get the string "...". The elements will be separated by the string " - ". For elements with cardinality n, the index within the list will be added at the end. If a schema key has been defined for an element, the key will be used as index for n, else the xpath-index will be applied. Example: /purchaseOrder/item[s]/item[1]/productDescription This would give following expression: purchaseOrder - item - item[1] - productDescription

Specified by:
getFullCaption in interface Type
Parameters:
labelLength - the length of each element description label that will be displayed
Returns:
an nls translated (if any) xpath of a type up to its upper most represented tree node parent

getId

public short[] getId()
Description copied from interface: Type
Gets a unique ID within the current JAXFront documennt (DOM) expressing axis position.

Specified by:
getId in interface Type
Returns:
a unique ID

getMixedContent

public Type getMixedContent()
Description copied from interface: Type
Returns the mixed content leaf type or null if none.

Specified by:
getMixedContent in interface Type

getName

public java.lang.String getName()
Description copied from interface: Type
Returns the name witout namespace previx.

Specified by:
getName in interface Type

getNamespace

public java.lang.String getNamespace()
Description copied from interface: Type
Gets the namespace name of the underlying W3C DOM.

Specified by:
getNamespace in interface Type
Returns:
the namespace name of the underlying W3C DOM

getNextSibling

public Type getNextSibling()
Description copied from interface: Type
Returns the next sibling type of the current type.

Specified by:
getNextSibling in interface Type
Returns:
the next sibling type

getParent

public Type getParent()
Description copied from interface: Type
Gets the parent type of the current type.

Specified by:
getParent in interface Type
Returns:
the parent type of the current type

getParent

public Type getParent(java.lang.String parentName)
Description copied from interface: Type
Gets the parent type with the given name.

Specified by:
getParent in interface Type
Parameters:
parentName - the name of the parent type
Returns:
the parent type with the given name

getParentList

public ListType getParentList()
Description copied from interface: Type
Gets the parent list type of the current type.

Specified by:
getParentList in interface Type
Returns:
the parent list type of the current type

getPrefixedXPathLocation

public java.lang.String getPrefixedXPathLocation()
Description copied from interface: Type
Gets the prefixed xpath location of the current type.

Specified by:
getPrefixedXPathLocation in interface Type
Returns:
the prefixed xpath location of the current type

getPreviousSibling

public Type getPreviousSibling()
Description copied from interface: Type
Returns the previous sibling type of the current type.

Specified by:
getPreviousSibling in interface Type
Returns:
the previous sibling type

getPropertyChangeSupport

public java.beans.PropertyChangeSupport getPropertyChangeSupport()
Description copied from interface: Type
Gets the PropertyChangeSupport helper instance for this type.

Specified by:
getPropertyChangeSupport in interface Type
Returns:
the PropertyChangeSupport helper instance for this type

getQName

public java.lang.String getQName()
Description copied from interface: Type
Gets the tag name including namespace prefix.

Specified by:
getQName in interface Type
Returns:
the tag name name including namespace prefix

getRepresentedTabParent

public Type getRepresentedTabParent(boolean checkCurrentType)
Description copied from interface: Type
Gets the holding tree parent type that is represented as tab.

Specified by:
getRepresentedTabParent in interface Type
Returns:
the holding tree parent type that is represented as tab

getRepresentedTableLayoutParent

public Type getRepresentedTableLayoutParent()
Description copied from interface: Type
Returns the type (one of my parents) which defines a tableLayout which represents this type or null.

Specified by:
getRepresentedTableLayoutParent in interface Type

getRepresentedTreeNodeHolder

public Type getRepresentedTreeNodeHolder()
Description copied from interface: Type
Gets the holding tree parent type in the navigation tree, where the view holder is self.

Specified by:
getRepresentedTreeNodeHolder in interface Type
Returns:
the holding tree parent type in the navigation tree

getRepresentedTreeNodeParent

public Type getRepresentedTreeNodeParent()
Description copied from interface: Type
Gets the holding tree parent type in the navigation tree.

Specified by:
getRepresentedTreeNodeParent in interface Type
Returns:
the holding tree parent type in the navigation tree

getRepresentedTreeNodeParentIcon

public javax.swing.ImageIcon getRepresentedTreeNodeParentIcon()
Description copied from interface: Type
Returns the uppermost icon that can be found of the tree node parents of the current type.

Specified by:
getRepresentedTreeNodeParentIcon in interface Type
Returns:
the icon of the uppermost tree node parent

getRepresentedTreeNodeParentIconName

public java.lang.String getRepresentedTreeNodeParentIconName()
Description copied from interface: Type
Returns the name of the uppermost icon that can be found of the tree node parents of the current type.

Specified by:
getRepresentedTreeNodeParentIconName in interface Type
Returns:
the name of the icon of the uppermost tree node parent

getSchemaElement

public SchemaNode getSchemaElement()
Description copied from interface: Type
Gets the meta information schema element.

Specified by:
getSchemaElement in interface Type
Returns:
the meta information schema element

getSerializationName

public java.lang.String getSerializationName()
Specified by:
getSerializationName in interface Type

getShortCaption

public java.lang.String getShortCaption()
Description copied from interface: Type
Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent. Only tree node parents are listed whereas all other parents as well as the root type are dismissed. Hierarchies are separated by " - ". Example: /purchaseOrder/shipToAdress/name -> purchaseOrder has a treeEntry, shipToAdress not. This would give following expression: purchaseOrder - name

Specified by:
getShortCaption in interface Type
Returns:
an nls translated (if any) xpath of a type up to its upper most represented tree node parent

getTemplate

public Type getTemplate()
Specified by:
getTemplate in interface Type

getTreeHierarchyContext

public java.lang.String getTreeHierarchyContext()
Description copied from interface: Type
Returns the treeEntry hierarchy of the current type as coma separated String (context).

Specified by:
getTreeHierarchyContext in interface Type
Returns:
the treeEntry hierarchy as String

getTypeClassification

public short getTypeClassification()
Description copied from interface: Type
Returns the type classification.

Specified by:
getTypeClassification in interface Type

getUserObject

public java.lang.Object getUserObject()
Description copied from interface: Type
Gets any user object set to this type.

Specified by:
getUserObject in interface Type
Returns:
any user object set to this type

getVisualName

public java.lang.String getVisualName()
Description copied from interface: Type
Returns the visual name of this type.

Specified by:
getVisualName in interface Type

getXPathLocation

public java.lang.String getXPathLocation()
Description copied from interface: Type
Gets the xpath location of the current type.

Specified by:
getXPathLocation in interface Type
Returns:
the xpath location of the current type

getW3CXPathLocation

public java.lang.String getW3CXPathLocation(boolean prefixed)
Description copied from interface: Type
Gets the W3C xpath location of the current type.This method returns the xpath without internal created unnamed elements!

Specified by:
getW3CXPathLocation in interface Type
Parameters:
prefixed - true if the xpath should be generated with namespace prefixes.
Returns:
the xpath location of the current type

getXUIDefinition

public XUIDefinition getXUIDefinition()
Description copied from interface: Type
Gets the current XUI definition.

Specified by:
getXUIDefinition in interface Type
Returns:
the current XUI definition

getXUIDefinition

public XUIDefinition getXUIDefinition(boolean create)
Description copied from interface: Type
Gets the current XUI definition saying if a xui definition should be initialized lazy if it does not exist.

Specified by:
getXUIDefinition in interface Type
Returns:
the current XUI definition

hasRecursionBeenBuilt

public boolean hasRecursionBeenBuilt()
Description copied from interface: Type
Returns true if type is a recursion holder and recursive start element has been created yet.

Specified by:
hasRecursionBeenBuilt in interface Type

hasRepresentableTreeChildren

public boolean hasRepresentableTreeChildren()
Description copied from interface: Type
Returns true if this type has any child types represented in the navigation tree.

Specified by:
hasRepresentableTreeChildren in interface Type
Returns:
true, if this type has any child types represented in the navigation tree, false otherwise

hasUIDefinition

public boolean hasUIDefinition()
Description copied from interface: Type
Returns true if the uiDefinition is alredy set.

Specified by:
hasUIDefinition in interface Type

hasUnChoosenChoiceParent

public boolean hasUnChoosenChoiceParent()
Description copied from interface: Type
Returns true if this type has an unchoosen choice parent, false otherwise

Specified by:
hasUnChoosenChoiceParent in interface Type

hasUndefinedChildren

public boolean hasUndefinedChildren()
Description copied from interface: Type
Returns true it this type holds a direct optional child.

Specified by:
hasUndefinedChildren in interface Type

hasValidationError

public boolean hasValidationError()
Description copied from interface: Type
Returns true if an validation error exists for this type.

Specified by:
hasValidationError in interface Type

isAbstract

public boolean isAbstract()
Description copied from interface: Type
Returns true if this type is defined abstract in the schema element.

Specified by:
isAbstract in interface Type
Returns:
true if this type is defined abstract in the schema element, false otherwise

isAnonymous

public boolean isAnonymous()
Description copied from interface: Type
Returns true if this type has no tag element (unnamed holder).

Specified by:
isAnonymous in interface Type
Returns:
true if this type has no tag element (unnamed holder), false otherwise

isAttribute

public boolean isAttribute()
Description copied from interface: Type
Returns true if this type is defined as an attribute in the XML schema.

Specified by:
isAttribute in interface Type
Returns:
true if this type is defined as an attribute in the XML schema, false otherwise

isChoice

public boolean isChoice()
Description copied from interface: Type
Returns true if this type is acting as a choice.

Specified by:
isChoice in interface Type
Returns:
true if this type is acting as a choice, false otherwise

isComposite

public boolean isComposite()
Description copied from interface: Type
Returns true if this type consists of other types.

Specified by:
isComposite in interface Type
Returns:
true if this type consists of other types, false otherwise

isDerived

public boolean isDerived()
Description copied from interface: Type
Returns true if this type is implementing an abstract type.

Specified by:
isDerived in interface Type
Returns:
true if this type is implementing an abstract type

isDerivedFrom

public boolean isDerivedFrom(Type type)
Description copied from interface: Type
Returns true if this type is a child of a given type.

Specified by:
isDerivedFrom in interface Type
Parameters:
type - parent type
Returns:
true if this type is a child of a given type, false otherwise

isDerivedFromEditingType

public boolean isDerivedFromEditingType()
Description copied from interface: Type
Returns true if this type is derived from an editing type.

Specified by:
isDerivedFromEditingType in interface Type

isEditingType

public boolean isEditingType()
Description copied from interface: Type
Returns true if my parent is a list and this type is a template for further addings.

Specified by:
isEditingType in interface Type
Returns:
true if my parent is a list and this type is a template for further addings, false otherwise

isEmpty

public boolean isEmpty()
Description copied from interface: Type
Returns true if this type is not represented in the target JAXFront DOM.

Specified by:
isEmpty in interface Type
Specified by:
isEmpty in interface java.util.Collection
Specified by:
isEmpty in interface java.util.List
Returns:
true if this type is not represented in the target JAXFront DOM, false otherwise

isGlobal

public boolean isGlobal()
Description copied from interface: Type
Return true it this type is global.

Specified by:
isGlobal in interface Type

isIncluded

public boolean isIncluded()
Description copied from interface: Type
Returns true if this type was included from an included xui file.

Specified by:
isIncluded in interface Type

isKey

public boolean isKey()
Description copied from interface: Type
Returns true if this type is a key selector.

Specified by:
isKey in interface Type

isKeyRef

public boolean isKeyRef()
Description copied from interface: Type
Returns true if this type is a key ref selector.

Specified by:
isKeyRef in interface Type

isList

public boolean isList()
Description copied from interface: Type
Returns true if this type represents a list.

Specified by:
isList in interface Type
Returns:
true if this type represents a list, false otherwise

isLocked

public boolean isLocked()
Description copied from interface: Type
Returns true if this type is locked via document.lock().

Specified by:
isLocked in interface Type
Returns:
true if this type is locked.

isRecursive

public boolean isRecursive()
Description copied from interface: Type
Returns true if this type is starting a new recursion.

Specified by:
isRecursive in interface Type

isReleased

public boolean isReleased()
Specified by:
isReleased in interface Type

isRepresentedAsHeader

public boolean isRepresentedAsHeader()
Description copied from interface: Type
Returns true if this type has a header.

Specified by:
isRepresentedAsHeader in interface Type
Returns:
true if this type has a header, false otherwise

isRepresentedAsTab

public boolean isRepresentedAsTab()
Description copied from interface: Type
Returns true if this type is represented as tab.

Specified by:
isRepresentedAsTab in interface Type
Returns:
true if this type is represented as tab, false otherwise

isRepresentedAsTreeNode

public boolean isRepresentedAsTreeNode()
Description copied from interface: Type
Returns true if this type is represented in the navigation tree.

Specified by:
isRepresentedAsTreeNode in interface Type
Returns:
true if this type is represented in the navigation tree, false otherwise

isRequired

public boolean isRequired()
Description copied from interface: Type
Returns true if this type is defined mandatory in the xml schema.

Specified by:
isRequired in interface Type
Returns:
true if this type is defined mandatory in the xml schema, false otherwise

isRoot

public boolean isRoot()
Description copied from interface: Type
Returns true if this type is the root of the JAXFront DOM.

Specified by:
isRoot in interface Type
Returns:
true if this type is the root of the JAXFront DOM, false otherwise

isSerializable

public boolean isSerializable()
Description copied from interface: Type
Returns true if this type should be serialized in the resulting W3C DOM.

Specified by:
isSerializable in interface Type
Returns:
true if this type should be serialized in the resulting W3C DOM, false otherwise

isSerializable

public boolean isSerializable(boolean checkValue)
Description copied from interface: Type
Returns true if this type should be serialized in the resulting W3C DOM.

Specified by:
isSerializable in interface Type
Parameters:
checkValue - true if the serialize process should check if the type's value is null
Returns:
true if this type should be serialized in the resulting W3C DOM, false otherwise

isSimple

public boolean isSimple()
Description copied from interface: Type
Returns true if this is a leaf in the tree.

Specified by:
isSimple in interface Type
Returns:
true if this is a leaf in the tree, false otherwise

isUserInstanciated

public boolean isUserInstanciated()
Specified by:
isUserInstanciated in interface Type

isVirtual

public boolean isVirtual()
Description copied from interface: Type
Returns true if this type is implementing an virtual type.

Specified by:
isVirtual in interface Type
Returns:
true if this type is implementing an virtual type

markAsDirtyXPath

public void markAsDirtyXPath()
Description copied from interface: Type
Marks an xpath as dirty. It will be recalculated the next time.

Specified by:
markAsDirtyXPath in interface Type

putClientProperty

public void putClientProperty(java.lang.String key,
                              java.lang.Object object)
Specified by:
putClientProperty in interface Type

release

public void release()
Description copied from interface: Type
Release all allocated resources for this type.

Specified by:
release in interface Type

remove

public boolean remove()
               throws ListModificationException
Description copied from interface: Type
Removes this type from the JAXFront DOM.

Specified by:
remove in interface Type
Throws:
ListModificationException

removeAll

public void removeAll()
               throws ListModificationException
Description copied from interface: Type
Removes all types from this type.

Specified by:
removeAll in interface Type
Throws:
ListModificationException

removeChild

public boolean removeChild(Type child)
                    throws ListModificationException
Description copied from interface: Type
Removes a child from the JAXFront DOM.

Specified by:
removeChild in interface Type
Parameters:
child - a child type of this type
Throws:
ListModificationException

removeClientProperty

public void removeClientProperty(java.lang.String key)
Specified by:
removeClientProperty in interface Type

removeMessage

public void removeMessage()
Description copied from interface: Type
Removes all validation error messages for this type.

Specified by:
removeMessage in interface Type

removeTreeNode

public void removeTreeNode(boolean shouldBeSerialized)
Description copied from interface: Type
Removes this type from the tree.

Specified by:
removeTreeNode in interface Type
Parameters:
shouldBeSerialized - defines if the content of this type will be serialized

serialize

public java.lang.StringBuffer serialize()
Description copied from interface: Type
Serializes the current subTree to a StringBuffer

Specified by:
serialize in interface Type

serialize

public void serialize(java.lang.StringBuffer sb,
                      int indent,
                      boolean writeName,
                      boolean recursive)
Description copied from interface: Type
Serializes the current subTree to a StringBuffer

Specified by:
serialize in interface Type
Parameters:
sb - a StringBuffer into which the subTree will be serialized
indent - size of indent
writeName - true, if the name of the type should be serialized, false otherwise
recursive - true, if all containing types should be serialized

setApplicationRequired

public void setApplicationRequired(boolean required)
Description copied from interface: Type
Sets if an user input is required for this type or not (overwrites xml schema cardinality).

Specified by:
setApplicationRequired in interface Type
Parameters:
required - true if an user input is required for this type

setBackground

public void setBackground(java.awt.Color color)
Specified by:
setBackground in interface Type
See Also:
Component.setBackground(java.awt.Color)

setChoosenType

public void setChoosenType(Type choosenType)
Description copied from interface: Type
Sets the choosen type if this type is a choice.

Specified by:
setChoosenType in interface Type
Parameters:
choosenType - the type that is currently choosen

setChoosenType

public void setChoosenType(Type choosenType,
                           boolean temporary)
Description copied from interface: Type
Sets the choosen type if this type is a choice.

Specified by:
setChoosenType in interface Type
Parameters:
choosenType - the type that is choosen
temporary - true, if the choosen type acts temporarily as choosen type, false otherwise

setCodeSetValues

public void setCodeSetValues(java.lang.String url,
                             java.lang.String codeSetName,
                             java.lang.String[] values,
                             java.lang.String defaultSelection)
Description copied from interface: Type
Sets the codeSet values for the current type.

Specified by:
setCodeSetValues in interface Type
Parameters:
url - the url of the codeSet to be set
codeSetName - the name of the codeSet to be set
values - the values of the codeSet
defaultSelection - the default selected code

setDOM

public void setDOM(Document DOM)
Description copied from interface: Type
Sets a current JAXFront document (DOM).

Specified by:
setDOM in interface Type
Parameters:
DOM - a JAXFront document (DOM)

setDirectChildValue

public void setDirectChildValue(java.lang.String childName,
                                java.lang.String value)
Description copied from interface: Type
Sets the value of a child type of this type.

Specified by:
setDirectChildValue in interface Type
Parameters:
childName - the name of the child
value - the value to set

setEditable

public void setEditable(boolean editable)
Description copied from interface: Type
Sets the component editable or not editable.

Specified by:
setEditable in interface Type

setEnabled

public void setEnabled(boolean enabled)
Description copied from interface: Type
Sets the component enabled (active) or disabled (inactive).

Specified by:
setEnabled in interface Type

setForeground

public void setForeground(java.awt.Color color)
Specified by:
setForeground in interface Type
See Also:
Component.setForeground(java.awt.Color)

setId

public void setId(short[] id)
Description copied from interface: Type
Sets a unique ID within the current JAXFront documennt (DOM) expressing axis position.

Specified by:
setId in interface Type
Parameters:
id - a unique ID

setLabelColor

public void setLabelColor(java.awt.Color color)
Specified by:
setLabelColor in interface Type
See Also:
Visualizer.setLabelColor(java.awt.Color)

setLabelText

public void setLabelText(java.lang.String text)
Specified by:
setLabelText in interface Type
See Also:
Visualizer.setLabelText(java.lang.String)

setParent

public void setParent(Type parent)
Description copied from interface: Type
Gets the parent type of the current type.

Specified by:
setParent in interface Type
Parameters:
parent - the parent type of the current type

setRenderable

public void setRenderable(boolean renderable)
Description copied from interface: Type
Defines if the type should be included into the rendering process. Note: If the type is not rendered it can't be make visible by an uiAction defined in a rule!

Specified by:
setRenderable in interface Type
Parameters:
renderable - false if the type should not be rendered

setSchemaElement

public void setSchemaElement(SchemaNode element)
Description copied from interface: Type
Sets the meta information schema element.

Specified by:
setSchemaElement in interface Type
Parameters:
element - the meta information schema element

setSerializable

public void setSerializable(boolean isDefined)
Description copied from interface: Type
Sets if this type should be serialized in the resulting W3C DOM.

Specified by:
setSerializable in interface Type
Parameters:
isDefined - true if this type should be serialized in the resulting W3C DOM, false otherwise

setSerializable

public void setSerializable(boolean isDefined,
                            boolean checkForEmptyContent)
Description copied from interface: Type
Sets if this type should be serialized in the resulting W3C DOM which depends on the content of the type. If the type has empty content it won't be serialized by default. If a type should be serialized even if it has empty content then set checkForEmptyContent to false which won't check the type for empty content during serializing.

Specified by:
setSerializable in interface Type
Parameters:
isDefined - true if this type should be serialized in the resulting W3C DOM, false otherwise
checkForEmptyContent - true if the content of this type should be checked for empty content

setTemplate

public void setTemplate(Type template)
Specified by:
setTemplate in interface Type

setTreeIcon

public void setTreeIcon(java.lang.String gifName)
Description copied from interface: Type
Set the tree icon for this type.

Specified by:
setTreeIcon in interface Type
Parameters:
gifName - name of the gif for the tree icon

setUIDefinition

public void setUIDefinition(XUIDefinition uiDefinition)
Description copied from interface: Type
Sets a XUI definition to this type.

Specified by:
setUIDefinition in interface Type
Parameters:
uiDefinition - a XUI definition

setUserInstanciated

public void setUserInstanciated(boolean userTriggered)
Specified by:
setUserInstanciated in interface Type

setUserObject

public void setUserObject(java.lang.Object object)
Description copied from interface: Type
Sets any user object to this type.

Specified by:
setUserObject in interface Type
Parameters:
object - any user object

setVisible

public void setVisible(boolean visible)
Description copied from interface: Type
Sets the visualizer of this type visible or invisible at runtime. Note: If you want to exclude the type of the rendering process, use setRenderable(false)!

Specified by:
setVisible in interface Type
Parameters:
visible - true if the component should be visible

setVisibleAndSerializable

public void setVisibleAndSerializable(boolean visible,
                                      boolean isSerializable)
Description copied from interface: Type
Sets the component visible or invisible and defines if the data will be serialized or not.

Specified by:
setVisibleAndSerializable in interface Type
Parameters:
visible - true if the component should be visible
isSerializable - true if the entered data should be serialized

showLabel

public void showLabel(boolean visible)
Description copied from interface: Type
Sets the label visible or invisible.

Specified by:
showLabel in interface Type
Parameters:
visible - true if the label should be visible

showMessage

public void showMessage(java.lang.String message,
                        java.lang.String classification,
                        boolean showDialog,
                        boolean needsUserAcceptance)
Description copied from interface: Type
Dislplays a message for this type with the passed information.

Specified by:
showMessage in interface Type
Parameters:
message - message text
classification - category (info, warning,...)
showDialog - defines if message should be shown as dialog
needsUserAcceptance - defines if user needs to accept message or not

isKeyContext

public boolean isKeyContext()
Description copied from interface: Type
Returns true if this type is a key context used in KeyKeyRefManager.

Specified by:
isKeyContext in interface Type

setIsKeyContext

public void setIsKeyContext(boolean isContext)
Description copied from interface: Type
Set true if this type is a key context!

Specified by:
setIsKeyContext in interface Type
Parameters:
isContext - true if this type is a key context

unChoosenBranch

public boolean unChoosenBranch()
Specified by:
unChoosenBranch in interface Type

getDirectChild

public Type getDirectChild(java.lang.String name,
                           java.lang.String namespace)
Description copied from interface: Type
Gets a direct child (next axis) type with a given name

Specified by:
getDirectChild in interface Type
Parameters:
name - name of the child
namespace - namespace of the child
Returns:
a child with the given name

getSchemaType

public SchemaType getSchemaType()
Specified by:
getSchemaType in interface Type

getStyle

public StyleDefinition getStyle()
Specified by:
getStyle in interface Type

completeRecursion

public void completeRecursion()
                       throws java.lang.CloneNotSupportedException
Description copied from interface: CompositeType
Creates a recursion of a schema element and returns a type that holds the types created during the recursion.

Specified by:
completeRecursion in interface CompositeType
Throws:
java.lang.CloneNotSupportedException

createChoiceType

public Type createChoiceType(java.lang.String name)
Description copied from interface: CompositeType
Lazy creation of a choice type.

Specified by:
createChoiceType in interface CompositeType
Parameters:
name - of the choice type.

createChoices

public void createChoices()
Description copied from interface: CompositeType
Lazy creates all choice axis.

Specified by:
createChoices in interface CompositeType

getAttributes

public java.util.List getAttributes()
Description copied from interface: CompositeType
Returns all its attributes.

Specified by:
getAttributes in interface CompositeType

getChoiceNames

public java.util.Set getChoiceNames()
Description copied from interface: CompositeType
In case of a choice, this will returns the choice names. Also nested unnamed choices will be considered.

Specified by:
getChoiceNames in interface CompositeType

getComposites

public java.util.List getComposites()
Specified by:
getComposites in interface CompositeType

getContentType

public SimpleType getContentType()
Description copied from interface: CompositeType
Gets a type that has simple content.

Specified by:
getContentType in interface CompositeType
Returns:
a type that has simple content

getEmptyType

public EmptyType getEmptyType()
Description copied from interface: CompositeType
Gets an empty type if this is a an optional choice.

Specified by:
getEmptyType in interface CompositeType
Returns:
an empty type or null

getParentEditingTypeForName

public Type getParentEditingTypeForName(java.lang.String choiceName)
Description copied from interface: CompositeType
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.

Specified by:
getParentEditingTypeForName in interface CompositeType

getRelevantChoiceNames

public java.lang.String[] getRelevantChoiceNames()
Description copied from interface: CompositeType
Returns an array of names of all direct choic options.

Specified by:
getRelevantChoiceNames in interface CompositeType

getRelevantChoiceTypes

public java.util.List getRelevantChoiceTypes()
Description copied from interface: CompositeType
Gets a list of all relevant choice types already created and without attribute types.

Specified by:
getRelevantChoiceTypes in interface CompositeType

hasAttributes

public boolean hasAttributes()
Description copied from interface: CompositeType
Returns true if this composite holds any attributes.

Specified by:
hasAttributes in interface CompositeType

hasEmptyContent

public boolean hasEmptyContent(boolean checkSerializeDefaults,
                               boolean checkDefaultValue)
Description copied from interface: CompositeType
Returns if any of the composite types has empty content.

Specified by:
hasEmptyContent in interface CompositeType
Returns:
true, if any of the composite types has empty content, false otherwise

hasOnlySimpleTypes

public boolean hasOnlySimpleTypes()
Description copied from interface: CompositeType
Returns true if all my children are simple types.

Specified by:
hasOnlySimpleTypes in interface CompositeType

removeChoices

public void removeChoices()
                   throws ListModificationException
Description copied from interface: CompositeType
Removes the selected choosen type.

Specified by:
removeChoices in interface CompositeType
Throws:
ListModificationException

add

public Type add(Type type)
Description copied from interface: ListType
Adds a new type to the list.

Specified by:
add in interface ListType
Parameters:
type - a new type to add
Returns:
the type that was added to the list

addNewChild

public Type addNewChild()
Description copied from interface: ListType
Adds a new child to the list.

Specified by:
addNewChild in interface ListType
Returns:
the new child that has been added to the list

addNewChild

public Type addNewChild(int index)
Specified by:
addNewChild in interface ListType

addNewChild

public Type addNewChild(Type templateType,
                        int targetIndex)
Description copied from interface: ListType
Copies the given templateType and adds it to the list at the given index position.

Specified by:
addNewChild in interface ListType
Parameters:
templateType - the child to be cloned or null if none
targetIndex - the index where to copy should be placed in the list
Returns:
the new child that has been added to the list

addNewChild

public Type addNewChild(Type template)
Description copied from interface: ListType
Adds a new child to the list.

Specified by:
addNewChild in interface ListType
Parameters:
template - the child to be added to the list
Returns:
the new child that has been added to the list

addNoTargetXUIDefinition

public void addNoTargetXUIDefinition(Type xuiType)
Description copied from interface: ListType
Adds an information to a XUI type if a list doesn't contain any types for which a XUI definition would exist. As soon as one or more types of the list exist(s), the XUI definition will be applied to them.

Specified by:
addNoTargetXUIDefinition in interface ListType
Parameters:
xuiType - the type for which a XUI definition exists but no subtypes were created

autoCreateEntries

public void autoCreateEntries()
Description copied from interface: ListType
Create the initial number of required min occur list items.

Specified by:
autoCreateEntries in interface ListType

bind

public void bind(Document DOM,
                 org.w3c.dom.Element instanceElement,
                 boolean bindOnlyAvailable,
                 boolean removeChilds)
Specified by:
bind in interface ListType

checkCardinality

public void checkCardinality(int changes)
                      throws ValidationException
Description copied from interface: ListType
Checks if removing or adding a new list entry violates the cardinality. The passed int value indicates: 0 = no change, simple validation 1 = try to add a new list entry -1 = try to remove a list entry

Specified by:
checkCardinality in interface ListType
Parameters:
changes - number of new list entries
Throws:
ValidationException

copyAndPasteChild

public void copyAndPasteChild(java.lang.Integer typeToCopyIndex,
                              java.lang.Integer targetIndex)
Specified by:
copyAndPasteChild in interface ListType

copyAndPasteChild

public void copyAndPasteChild(Type typeToCopy,
                              java.lang.Integer targetIndex)
Specified by:
copyAndPasteChild in interface ListType

copyAndPasteChild

public void copyAndPasteChild(Type typeToCopy)
Specified by:
copyAndPasteChild in interface ListType

copyChild

public Type copyChild(java.lang.Integer index)
Description copied from interface: ListType
Copies the child with the given index and returns it.

Specified by:
copyChild in interface ListType

delete

public java.lang.Object delete(Type type)
                        throws ListModificationException
Description copied from interface: ListType
Deletes a type from the list.

Specified by:
delete in interface ListType
Parameters:
type - the type to delete
Throws:
ListModificationException

getEditingType

public Type getEditingType()
Description copied from interface: ListType
Gets the current editable type of the list.

Specified by:
getEditingType in interface ListType
Returns:
the current editable type of the list

getList

public java.util.List getList()
Description copied from interface: ListType
Gets the list of types.

Specified by:
getList in interface ListType
Returns:
the list of types

getMaxOccurs

public int getMaxOccurs()
Description copied from interface: ListType
Returns the maximum number of allowed list entries.

Specified by:
getMaxOccurs in interface ListType

getMinOccurs

public int getMinOccurs()
Description copied from interface: ListType
Returns the minimum number of allowed list entries.

Specified by:
getMinOccurs in interface ListType

getSortIndexes

public int[] getSortIndexes()
Description copied from interface: ListType
Returns the sort indexes or null.

Specified by:
getSortIndexes in interface ListType

isListItemRemoveable

public boolean isListItemRemoveable(Type type)
                             throws ListModificationException
Specified by:
isListItemRemoveable in interface ListType
Throws:
ListModificationException

maintainXUIDefinitions

public void maintainXUIDefinitions(Type type)
Description copied from interface: ListType
Traverses down the editing type and maintains all the xui definitions set on the editing type axis to the passed type.

Specified by:
maintainXUIDefinitions in interface ListType

move

public void move(int from,
                 int to)
Description copied from interface: ListType
Moves the type from position "from" to position "to", shifting the other elements

Specified by:
move in interface ListType
Parameters:
from - the source position
to - the destination position

removeAll

public void removeAll(boolean isTemporary,
                      boolean checkCardinality)
Description copied from interface: ListType
Removes all childs of the list.

Specified by:
removeAll in interface ListType
Parameters:
isTemporary - indicates if this deletion is temporary
checkCardinality - indicates if cardinality violation should be checked

removeChild

public java.lang.Object removeChild(int index)
                             throws ListModificationException
Description copied from interface: ListType
Removes the list item with the given index from the list.

Specified by:
removeChild in interface ListType
Parameters:
index - the index of the list item to should be removed from the list
Throws:
ListModificationException

removeLastChild

public java.lang.Object removeLastChild(boolean temporary)
                                 throws ListModificationException
Description copied from interface: ListType
Removes the last list item from the list.

Specified by:
removeLastChild in interface ListType
Parameters:
temporary - indicates if the deletion is temporary
Throws:
ListModificationException

removeNoTargetXUIDefinition

public void removeNoTargetXUIDefinition(Type xuiType)
Description copied from interface: ListType
Removes an information of a XUI type if a list doesn't contain any types for which a XUI definition would exist. As soon as one or more types of the list exist(s), the XUI definition will be applied to them.

Specified by:
removeNoTargetXUIDefinition in interface ListType
Parameters:
xuiType - the type for which a XUI definition exists but no subtypes were created

setEditingType

public void setEditingType(Type editingType)
Description copied from interface: ListType
Resets the editing type.

Specified by:
setEditingType in interface ListType
Parameters:
editingType - template type for a list

setList

public void setList(java.util.List list)
Description copied from interface: ListType
Sets the list entries.

Specified by:
setList in interface ListType
Parameters:
list - list entries

setSortIndexes

public void setSortIndexes(int[] sortIndexes)
Description copied from interface: ListType
Set the sort indexes.

Specified by:
setSortIndexes in interface ListType
Parameters:
sortIndexes - new sort index array

swap

public void swap(int from,
                 int to)
Description copied from interface: ListType
Swaps the position of two given types in the list

Specified by:
swap in interface ListType
Parameters:
from - the source position
to - the destination position

violateCardinality

public boolean violateCardinality(int changes)
Description copied from interface: ListType
Checks if removing or adding a new list entry violates the cardinality. The passed int value indicates: true = ok, false = violate cardinality 0 = no change, simple validation 1 = try to add a new list entry -1 = try to remove a list entry

Specified by:
violateCardinality in interface ListType
Parameters:
changes - number of new list entries

add

public boolean add(java.lang.Object arg0)
Specified by:
add in interface java.util.Collection
Specified by:
add in interface java.util.List

add

public void add(int arg0,
                java.lang.Object arg1)
Specified by:
add in interface java.util.List

addAll

public boolean addAll(java.util.Collection arg0)
Specified by:
addAll in interface java.util.Collection
Specified by:
addAll in interface java.util.List

addAll

public boolean addAll(int arg0,
                      java.util.Collection arg1)
Specified by:
addAll in interface java.util.List

clear

public void clear()
Specified by:
clear in interface java.util.Collection
Specified by:
clear in interface java.util.List

contains

public boolean contains(java.lang.Object o)
Specified by:
contains in interface java.util.Collection
Specified by:
contains in interface java.util.List

containsAll

public boolean containsAll(java.util.Collection arg0)
Specified by:
containsAll in interface java.util.Collection
Specified by:
containsAll in interface java.util.List

get

public java.lang.Object get(int index)
Specified by:
get in interface java.util.List

indexOf

public int indexOf(java.lang.Object o)
Specified by:
indexOf in interface java.util.List

iterator

public java.util.Iterator iterator()
Specified by:
iterator in interface java.lang.Iterable
Specified by:
iterator in interface java.util.Collection
Specified by:
iterator in interface java.util.List

lastIndexOf

public int lastIndexOf(java.lang.Object o)
Specified by:
lastIndexOf in interface java.util.List

listIterator

public java.util.ListIterator listIterator()
Specified by:
listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int index)
Specified by:
listIterator in interface java.util.List

remove

public boolean remove(java.lang.Object o)
Specified by:
remove in interface java.util.Collection
Specified by:
remove in interface java.util.List

remove

public java.lang.Object remove(int index)
Specified by:
remove in interface java.util.List

removeAll

public boolean removeAll(java.util.Collection arg0)
Specified by:
removeAll in interface java.util.Collection
Specified by:
removeAll in interface java.util.List

retainAll

public boolean retainAll(java.util.Collection arg0)
Specified by:
retainAll in interface java.util.Collection
Specified by:
retainAll in interface java.util.List

set

public java.lang.Object set(int arg0,
                            java.lang.Object arg1)
Specified by:
set in interface java.util.List

size

public int size()
Specified by:
size in interface java.util.Collection
Specified by:
size in interface java.util.List

subList

public java.util.List subList(int fromIndex,
                              int toIndex)
Specified by:
subList in interface java.util.List

toArray

public java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.List

toArray

public java.lang.Object[] toArray(java.lang.Object[] arg0)
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.List

deepClone

public Type deepClone(Document dom,
                      boolean cloneChoices,
                      boolean includingData,
                      boolean includeEditingType,
                      SchemaNode schemaNode,
                      org.w3c.dom.Element element)
               throws java.lang.CloneNotSupportedException
Description copied from interface: Type
Creates a deep clone of this type and all its referenced types.

Specified by:
deepClone in interface Type
Parameters:
dom - the current dom to which this type belongs
includingData - indicates if all binded data should be copied as well (default is false)
Returns:
the cloned type
Throws:
java.lang.CloneNotSupportedException