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.

Speci