org.odftoolkit.odfdom.dom.element.table
Class TableDataPilotFieldElement

java.lang.Object
  extended by org.apache.xerces.dom.NodeImpl
      extended by org.apache.xerces.dom.ChildNode
          extended by org.apache.xerces.dom.ParentNode
              extended by org.apache.xerces.dom.ElementImpl
                  extended by org.apache.xerces.dom.ElementNSImpl
                      extended by org.odftoolkit.odfdom.pkg.OdfElement
                          extended by org.odftoolkit.odfdom.dom.element.table.TableDataPilotFieldElement
All Implemented Interfaces:
Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo

public class TableDataPilotFieldElement
extends OdfElement

DOM implementation of OpenDocument element table:data-pilot-field.

See Also:
Serialized Form

Field Summary
static OdfName ELEMENT_NAME
           
 
Fields inherited from class org.apache.xerces.dom.ElementNSImpl
localName, namespaceURI
 
Fields inherited from class org.apache.xerces.dom.ElementImpl
attributes, name
 
Fields inherited from class org.apache.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
 
Fields inherited from class org.apache.xerces.dom.ChildNode
nextSibling, previousSibling
 
Fields inherited from class org.apache.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Fields inherited from interface org.w3c.dom.TypeInfo
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION
 
Constructor Summary
TableDataPilotFieldElement(OdfFileDom ownerDoc)
          Create the instance of TableDataPilotFieldElement
 
Method Summary
 void accept(ElementVisitor visitor)
          Accept an visitor instance to allow the visitor to do some operations.
 OdfName getOdfName()
          Get the element name
 String getTableFunctionAttribute()
          Receives the value of the ODFDOM attribute representation TableFunctionAttribute , See table:function
 String getTableIsDataLayoutFieldAttribute()
          Receives the value of the ODFDOM attribute representation TableIsDataLayoutFieldAttribute , See table:is-data-layout-field
 String getTableOrientationAttribute()
          Receives the value of the ODFDOM attribute representation TableOrientationAttribute , See table:orientation Attribute is mandatory.
 String getTableSelectedPageAttribute()
          Receives the value of the ODFDOM attribute representation TableSelectedPageAttribute , See table:selected-page
 String getTableSourceFieldNameAttribute()
          Receives the value of the ODFDOM attribute representation TableSourceFieldNameAttribute , See table:source-field-name Attribute is mandatory.
 Integer getTableUsedHierarchyAttribute()
          Receives the value of the ODFDOM attribute representation TableUsedHierarchyAttribute , See table:used-hierarchy
 TableDataPilotFieldReferenceElement newTableDataPilotFieldReferenceElement(String tableFieldNameValue, String tableMemberTypeValue, String tableTypeValue)
          Create child element table:data-pilot-field-reference.
 TableDataPilotGroupsElement newTableDataPilotGroupsElement(String tableGroupedByValue, String tableSourceFieldNameValue, double tableStepValue)
          Create child element table:data-pilot-groups.
 TableDataPilotLevelElement newTableDataPilotLevelElement()
          Create child element table:data-pilot-level.
 void setTableFunctionAttribute(String tableFunctionValue)
          Sets the value of ODFDOM attribute representation TableFunctionAttribute , See table:function
 void setTableIsDataLayoutFieldAttribute(String tableIsDataLayoutFieldValue)
          Sets the value of ODFDOM attribute representation TableIsDataLayoutFieldAttribute , See table:is-data-layout-field
 void setTableOrientationAttribute(String tableOrientationValue)
          Sets the value of ODFDOM attribute representation TableOrientationAttribute , See table:orientation
 void setTableSelectedPageAttribute(String tableSelectedPageValue)
          Sets the value of ODFDOM attribute representation TableSelectedPageAttribute , See table:selected-page
 void setTableSourceFieldNameAttribute(String tableSourceFieldNameValue)
          Sets the value of ODFDOM attribute representation TableSourceFieldNameAttribute , See table:source-field-name
 void setTableUsedHierarchyAttribute(Integer tableUsedHierarchyValue)
          Sets the value of ODFDOM attribute representation TableUsedHierarchyAttribute , See table:used-hierarchy
 
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement
cloneNode, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, hasOdfAttribute, insertBefore, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, removeChild, replaceChild, setOdfAttribute, setOdfAttributeValue, toString
 
Methods inherited from class org.apache.xerces.dom.ElementNSImpl
getBaseURI, getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setPrefix, setType, setValues
 
Methods inherited from class org.apache.xerces.dom.ElementImpl
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttribute, hasAttributeNS, hasAttributes, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData
 
Methods inherited from class org.apache.xerces.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, item, setTextContent, synchronizeChildren
 
Methods inherited from class org.apache.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
 
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, appendChild, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setUserData, setUserData
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData
 

Field Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME
Constructor Detail

TableDataPilotFieldElement

public TableDataPilotFieldElement(OdfFileDom ownerDoc)
Create the instance of TableDataPilotFieldElement

Parameters:
ownerDoc - The type is OdfFileDom
Method Detail

getOdfName

public OdfName getOdfName()
Get the element name

Specified by:
getOdfName in class OdfElement
Returns:
return OdfName the name of element table:data-pilot-field.

getTableFunctionAttribute

public String getTableFunctionAttribute()
Receives the value of the ODFDOM attribute representation TableFunctionAttribute , See table:function

Returns:
- the String , the value or null, if the attribute is not set and no default value defined.

setTableFunctionAttribute

public void setTableFunctionAttribute(String tableFunctionValue)
Sets the value of ODFDOM attribute representation TableFunctionAttribute , See table:function

Parameters:
tableFunctionValue - The type is String

getTableIsDataLayoutFieldAttribute

public String getTableIsDataLayoutFieldAttribute()
Receives the value of the ODFDOM attribute representation TableIsDataLayoutFieldAttribute , See table:is-data-layout-field

Returns:
- the String , the value or null, if the attribute is not set and no default value defined.

setTableIsDataLayoutFieldAttribute

public void setTableIsDataLayoutFieldAttribute(String tableIsDataLayoutFieldValue)
Sets the value of ODFDOM attribute representation TableIsDataLayoutFieldAttribute , See table:is-data-layout-field

Parameters:
tableIsDataLayoutFieldValue - The type is String

getTableOrientationAttribute

public String getTableOrientationAttribute()
Receives the value of the ODFDOM attribute representation TableOrientationAttribute , See table:orientation Attribute is mandatory.

Returns:
- the String , the value or null, if the attribute is not set and no default value defined.

setTableOrientationAttribute

public void setTableOrientationAttribute(String tableOrientationValue)
Sets the value of ODFDOM attribute representation TableOrientationAttribute , See table:orientation

Parameters:
tableOrientationValue - The type is String

getTableSelectedPageAttribute

public String getTableSelectedPageAttribute()
Receives the value of the ODFDOM attribute representation TableSelectedPageAttribute , See table:selected-page

Returns:
- the String , the value or null, if the attribute is not set and no default value defined.

setTableSelectedPageAttribute

public void setTableSelectedPageAttribute(String tableSelectedPageValue)
Sets the value of ODFDOM attribute representation TableSelectedPageAttribute , See table:selected-page

Parameters:
tableSelectedPageValue - The type is String

getTableSourceFieldNameAttribute

public String getTableSourceFieldNameAttribute()
Receives the value of the ODFDOM attribute representation TableSourceFieldNameAttribute , See table:source-field-name Attribute is mandatory.

Returns:
- the String , the value or null, if the attribute is not set and no default value defined.

setTableSourceFieldNameAttribute

public void setTableSourceFieldNameAttribute(String tableSourceFieldNameValue)
Sets the value of ODFDOM attribute representation TableSourceFieldNameAttribute , See table:source-field-name

Parameters:
tableSourceFieldNameValue - The type is String

getTableUsedHierarchyAttribute

public Integer getTableUsedHierarchyAttribute()
Receives the value of the ODFDOM attribute representation TableUsedHierarchyAttribute , See table:used-hierarchy

Returns:
- the Integer , the value or null, if the attribute is not set and no default value defined.

setTableUsedHierarchyAttribute

public void setTableUsedHierarchyAttribute(Integer tableUsedHierarchyValue)
Sets the value of ODFDOM attribute representation TableUsedHierarchyAttribute , See table:used-hierarchy

Parameters:
tableUsedHierarchyValue - The type is Integer

newTableDataPilotFieldReferenceElement

public TableDataPilotFieldReferenceElement newTableDataPilotFieldReferenceElement(String tableFieldNameValue,
                                                                                  String tableMemberTypeValue,
                                                                                  String tableTypeValue)
Create child element table:data-pilot-field-reference.

Parameters:
tableFieldNameValue - the String value of TableFieldNameAttribute, see table:field-name at specification
tableMemberTypeValue - the String value of TableMemberTypeAttribute, see table:member-type at specification
tableTypeValue - the String value of TableTypeAttribute, see table:type at specification
Returns:
the element table:data-pilot-field-reference

newTableDataPilotGroupsElement

public TableDataPilotGroupsElement newTableDataPilotGroupsElement(String tableGroupedByValue,
                                                                  String tableSourceFieldNameValue,
                                                                  double tableStepValue)
Create child element table:data-pilot-groups.

Parameters:
tableGroupedByValue - the String value of TableGroupedByAttribute, see table:grouped-by at specification
tableSourceFieldNameValue - the String value of TableSourceFieldNameAttribute, see table:source-field-name at specification
tableStepValue - the Double value of TableStepAttribute, see table:step at specification
Returns:
the element table:data-pilot-groups

newTableDataPilotLevelElement

public TableDataPilotLevelElement newTableDataPilotLevelElement()
Create child element table:data-pilot-level.

Returns:
the element table:data-pilot-level

accept

public void accept(ElementVisitor visitor)
Description copied from class: OdfElement
Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design pattern to get a better understanding.

Overrides:
accept in class OdfElement
Parameters:
visitor - an instance of DefaultElementVisitor


Copyright © 2008-2011 The Apache Software Foundation. All Rights Reserved.