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

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.TableDataPilotTableElement
All Implemented Interfaces:
Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo

public class TableDataPilotTableElement
extends OdfElement

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

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
TableDataPilotTableElement(OdfFileDom ownerDoc)
          Create the instance of TableDataPilotTableElement
 
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 getTableApplicationDataAttribute()
          Receives the value of the ODFDOM attribute representation TableApplicationDataAttribute , See table:application-data
 String getTableButtonsAttribute()
          Receives the value of the ODFDOM attribute representation TableButtonsAttribute , See table:buttons
 Boolean getTableDrillDownOnDoubleClickAttribute()
          Receives the value of the ODFDOM attribute representation TableDrillDownOnDoubleClickAttribute , See table:drill-down-on-double-click
 String getTableGrandTotalAttribute()
          Receives the value of the ODFDOM attribute representation TableGrandTotalAttribute , See table:grand-total
 Boolean getTableIdentifyCategoriesAttribute()
          Receives the value of the ODFDOM attribute representation TableIdentifyCategoriesAttribute , See table:identify-categories
 Boolean getTableIgnoreEmptyRowsAttribute()
          Receives the value of the ODFDOM attribute representation TableIgnoreEmptyRowsAttribute , See table:ignore-empty-rows
 String getTableNameAttribute()
          Receives the value of the ODFDOM attribute representation TableNameAttribute , See table:name Attribute is mandatory.
 Boolean getTableShowFilterButtonAttribute()
          Receives the value of the ODFDOM attribute representation TableShowFilterButtonAttribute , See table:show-filter-button
 String getTableTargetRangeAddressAttribute()
          Receives the value of the ODFDOM attribute representation TableTargetRangeAddressAttribute , See table:target-range-address Attribute is mandatory.
 TableDatabaseSourceQueryElement newTableDatabaseSourceQueryElement(String tableDatabaseNameValue, String tableQueryNameValue)
          Create child element table:database-source-query.
 TableDatabaseSourceSqlElement newTableDatabaseSourceSqlElement(String tableDatabaseNameValue, String tableSqlStatementValue)
          Create child element table:database-source-sql.
 TableDatabaseSourceTableElement newTableDatabaseSourceTableElement(String tableDatabaseNameValue, String tableDatabaseTableNameValue)
          Create child element table:database-source-table.
 TableDataPilotFieldElement newTableDataPilotFieldElement(String tableOrientationValue, String tableSourceFieldNameValue)
          Create child element table:data-pilot-field.
 TableSourceCellRangeElement newTableSourceCellRangeElement(String tableCellRangeAddressValue)
          Create child element table:source-cell-range.
 TableSourceServiceElement newTableSourceServiceElement(String tableNameValue, String tableObjectNameValue, String tableSourceNameValue)
          Create child element table:source-service.
 void setTableApplicationDataAttribute(String tableApplicationDataValue)
          Sets the value of ODFDOM attribute representation TableApplicationDataAttribute , See table:application-data
 void setTableButtonsAttribute(String tableButtonsValue)
          Sets the value of ODFDOM attribute representation TableButtonsAttribute , See table:buttons
 void setTableDrillDownOnDoubleClickAttribute(Boolean tableDrillDownOnDoubleClickValue)
          Sets the value of ODFDOM attribute representation TableDrillDownOnDoubleClickAttribute , See table:drill-down-on-double-click
 void setTableGrandTotalAttribute(String tableGrandTotalValue)
          Sets the value of ODFDOM attribute representation TableGrandTotalAttribute , See table:grand-total
 void setTableIdentifyCategoriesAttribute(Boolean tableIdentifyCategoriesValue)
          Sets the value of ODFDOM attribute representation TableIdentifyCategoriesAttribute , See table:identify-categories
 void setTableIgnoreEmptyRowsAttribute(Boolean tableIgnoreEmptyRowsValue)
          Sets the value of ODFDOM attribute representation TableIgnoreEmptyRowsAttribute , See table:ignore-empty-rows
 void setTableNameAttribute(String tableNameValue)
          Sets the value of ODFDOM attribute representation TableNameAttribute , See table:name
 void setTableShowFilterButtonAttribute(Boolean tableShowFilterButtonValue)
          Sets the value of ODFDOM attribute representation TableShowFilterButtonAttribute , See table:show-filter-button
 void setTableTargetRangeAddressAttribute(String tableTargetRangeAddressValue)
          Sets the value of ODFDOM attribute representation TableTargetRangeAddressAttribute , See table:target-range-address
 
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

TableDataPilotTableElement

public TableDataPilotTableElement(OdfFileDom ownerDoc)
Create the instance of TableDataPilotTableElement

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-table.

getTableApplicationDataAttribute

public String getTableApplicationDataAttribute()
Receives the value of the ODFDOM attribute representation TableApplicationDataAttribute , See table:application-data

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

setTableApplicationDataAttribute

public void setTableApplicationDataAttribute(String tableApplicationDataValue)
Sets the value of ODFDOM attribute representation TableApplicationDataAttribute , See table:application-data

Parameters:
tableApplicationDataValue - The type is String

getTableButtonsAttribute

public String getTableButtonsAttribute()
Receives the value of the ODFDOM attribute representation TableButtonsAttribute , See table:buttons

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

setTableButtonsAttribute

public void setTableButtonsAttribute(String tableButtonsValue)
Sets the value of ODFDOM attribute representation TableButtonsAttribute , See table:buttons

Parameters:
tableButtonsValue - The type is String

getTableDrillDownOnDoubleClickAttribute

public Boolean getTableDrillDownOnDoubleClickAttribute()
Receives the value of the ODFDOM attribute representation TableDrillDownOnDoubleClickAttribute , See table:drill-down-on-double-click

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

setTableDrillDownOnDoubleClickAttribute

public void setTableDrillDownOnDoubleClickAttribute(Boolean tableDrillDownOnDoubleClickValue)
Sets the value of ODFDOM attribute representation TableDrillDownOnDoubleClickAttribute , See table:drill-down-on-double-click

Parameters:
tableDrillDownOnDoubleClickValue - The type is Boolean

getTableGrandTotalAttribute

public String getTableGrandTotalAttribute()
Receives the value of the ODFDOM attribute representation TableGrandTotalAttribute , See table:grand-total

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

setTableGrandTotalAttribute

public void setTableGrandTotalAttribute(String tableGrandTotalValue)
Sets the value of ODFDOM attribute representation TableGrandTotalAttribute , See table:grand-total

Parameters:
tableGrandTotalValue - The type is String

getTableIdentifyCategoriesAttribute

public Boolean getTableIdentifyCategoriesAttribute()
Receives the value of the ODFDOM attribute representation TableIdentifyCategoriesAttribute , See table:identify-categories

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

setTableIdentifyCategoriesAttribute

public void setTableIdentifyCategoriesAttribute(Boolean tableIdentifyCategoriesValue)
Sets the value of ODFDOM attribute representation TableIdentifyCategoriesAttribute , See table:identify-categories

Parameters:
tableIdentifyCategoriesValue - The type is Boolean

getTableIgnoreEmptyRowsAttribute

public Boolean getTableIgnoreEmptyRowsAttribute()
Receives the value of the ODFDOM attribute representation TableIgnoreEmptyRowsAttribute , See table:ignore-empty-rows

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

setTableIgnoreEmptyRowsAttribute

public void setTableIgnoreEmptyRowsAttribute(Boolean tableIgnoreEmptyRowsValue)
Sets the value of ODFDOM attribute representation TableIgnoreEmptyRowsAttribute , See table:ignore-empty-rows

Parameters:
tableIgnoreEmptyRowsValue - The type is Boolean

getTableNameAttribute

public String getTableNameAttribute()
Receives the value of the ODFDOM attribute representation TableNameAttribute , See table:name Attribute is mandatory.

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

setTableNameAttribute

public void setTableNameAttribute(String tableNameValue)
Sets the value of ODFDOM attribute representation TableNameAttribute , See table:name

Parameters:
tableNameValue - The type is String

getTableShowFilterButtonAttribute

public Boolean getTableShowFilterButtonAttribute()
Receives the value of the ODFDOM attribute representation TableShowFilterButtonAttribute , See table:show-filter-button

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

setTableShowFilterButtonAttribute

public void setTableShowFilterButtonAttribute(Boolean tableShowFilterButtonValue)
Sets the value of ODFDOM attribute representation TableShowFilterButtonAttribute , See table:show-filter-button

Parameters:
tableShowFilterButtonValue - The type is Boolean

getTableTargetRangeAddressAttribute

public String getTableTargetRangeAddressAttribute()
Receives the value of the ODFDOM attribute representation TableTargetRangeAddressAttribute , See table:target-range-address Attribute is mandatory.

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

setTableTargetRangeAddressAttribute

public void setTableTargetRangeAddressAttribute(String tableTargetRangeAddressValue)
Sets the value of ODFDOM attribute representation TableTargetRangeAddressAttribute , See table:target-range-address

Parameters:
tableTargetRangeAddressValue - The type is String

newTableDataPilotFieldElement

public TableDataPilotFieldElement newTableDataPilotFieldElement(String tableOrientationValue,
                                                                String tableSourceFieldNameValue)
Create child element table:data-pilot-field.

Parameters:
tableOrientationValue - the String value of TableOrientationAttribute, see table:orientation at specification
tableSourceFieldNameValue - the String value of TableSourceFieldNameAttribute, see table:source-field-name at specification Child element is mandatory.
Returns:
the element table:data-pilot-field

newTableDatabaseSourceQueryElement

public TableDatabaseSourceQueryElement newTableDatabaseSourceQueryElement(String tableDatabaseNameValue,
                                                                          String tableQueryNameValue)
Create child element table:database-source-query.

Parameters:
tableDatabaseNameValue - the String value of TableDatabaseNameAttribute, see table:database-name at specification
tableQueryNameValue - the String value of TableQueryNameAttribute, see table:query-name at specification
Returns:
the element table:database-source-query

newTableDatabaseSourceSqlElement

public TableDatabaseSourceSqlElement newTableDatabaseSourceSqlElement(String tableDatabaseNameValue,
                                                                      String tableSqlStatementValue)
Create child element table:database-source-sql.

Parameters:
tableDatabaseNameValue - the String value of TableDatabaseNameAttribute, see table:database-name at specification
tableSqlStatementValue - the String value of TableSqlStatementAttribute, see table:sql-statement at specification
Returns:
the element table:database-source-sql

newTableDatabaseSourceTableElement

public TableDatabaseSourceTableElement newTableDatabaseSourceTableElement(String tableDatabaseNameValue,
                                                                          String tableDatabaseTableNameValue)
Create child element table:database-source-table.

Parameters:
tableDatabaseNameValue - the String value of TableDatabaseNameAttribute, see table:database-name at specification
tableDatabaseTableNameValue - the String value of TableDatabaseTableNameAttribute, see table:database-table-name at specification
Returns:
the element table:database-source-table

newTableSourceCellRangeElement

public TableSourceCellRangeElement newTableSourceCellRangeElement(String tableCellRangeAddressValue)
Create child element table:source-cell-range.

Parameters:
tableCellRangeAddressValue - the String value of TableCellRangeAddressAttribute, see table:cell-range-address at specification
Returns:
the element table:source-cell-range

newTableSourceServiceElement

public TableSourceServiceElement newTableSourceServiceElement(String tableNameValue,
                                                              String tableObjectNameValue,
                                                              String tableSourceNameValue)
Create child element table:source-service.

Parameters:
tableNameValue - the String value of TableNameAttribute, see table:name at specification
tableObjectNameValue - the String value of TableObjectNameAttribute, see table:object-name at specification
tableSourceNameValue - the String value of TableSourceNameAttribute, see table:source-name at specification
Returns:
the element table:source-service

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.