Package org.odftoolkit.odfdom.dom.element.db

Class DbIndexElement

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.ElementImpl

org.apache.xerces.dom.ElementNSImpl

org.odftoolkit.odfdom.pkg.OdfElement

org.odftoolkit.odfdom.dom.element.db.DbIndexElement

All Implemented Interfaces:

Serializable, Cloneable, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo

public class DbIndexElement
extends OdfElement

DOM implementation of OpenDocument element <db:index>.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
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

Constructors

Constructor	Description
DbIndexElement(OdfFileDom ownerDoc)	Create the instance of DbIndexElement

Method Summary

Modifier and Type	Method	Description
void	accept(ElementVisitor visitor)	Accept an visitor instance to allow the visitor to do some operations.
String	getDbCatalogNameAttribute()	Receives the value of the ODFDOM attribute representation DbCatalogNameAttribute , See @db:catalog-name
Boolean	getDbIsClusteredAttribute()	Receives the value of the ODFDOM attribute representation DbIsClusteredAttribute , See @db:is-clustered
Boolean	getDbIsUniqueAttribute()	Receives the value of the ODFDOM attribute representation DbIsUniqueAttribute , See @db:is-unique
String	getDbNameAttribute()	Receives the value of the ODFDOM attribute representation DbNameAttribute , See @db:name
OdfName	getOdfName()	Get the element name
DbIndexColumnsElement	newDbIndexColumnsElement()	Create child element <db:index-columns>.
void	setDbCatalogNameAttribute(String dbCatalogNameValue)	Sets the value of ODFDOM attribute representation DbCatalogNameAttribute , See @db:catalog-name
void	setDbIsClusteredAttribute(Boolean dbIsClusteredValue)	Sets the value of ODFDOM attribute representation DbIsClusteredAttribute , See @db:is-clustered
void	setDbIsUniqueAttribute(Boolean dbIsUniqueValue)	Sets the value of ODFDOM attribute representation DbIsUniqueAttribute , See @db:is-unique
void	setDbNameAttribute(String dbNameValue)	Sets the value of ODFDOM attribute representation DbNameAttribute , See @db:name

Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement

appendChild, appendUsingWhitespaceHandling, cloneElement, cloneNode, cloneNode, cloneNode, cloneOdfElement, componentSize, copyAttributes, countChildComponents, countDescendantComponents, countPrecedingSiblingElements, delete, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getChildElement, getChildElement, getComponent, getComponentRoot, getFirstChildElement, getLastChildElement, getNextSiblingElement, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, setOdfAttribute, setOdfAttributeValue, setRepetition, split, toString

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setPrefix, setType

Methods inherited from class org.apache.xerces.dom.ElementImpl

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, 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, 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, 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

compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData

Field Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Detail

DbIndexElement

public DbIndexElement(OdfFileDom ownerDoc)

Create the instance of DbIndexElement

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 <db:index>.

getDbCatalogNameAttribute

public String getDbCatalogNameAttribute()

Receives the value of the ODFDOM attribute representation DbCatalogNameAttribute , See @db:catalog-name

Returns:

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

setDbCatalogNameAttribute

public void setDbCatalogNameAttribute(String dbCatalogNameValue)

Sets the value of ODFDOM attribute representation DbCatalogNameAttribute , See @db:catalog-name

Parameters:

dbCatalogNameValue - The type is String

getDbIsClusteredAttribute

public Boolean getDbIsClusteredAttribute()

Receives the value of the ODFDOM attribute representation DbIsClusteredAttribute , See @db:is-clustered

Returns:

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

setDbIsClusteredAttribute

public void setDbIsClusteredAttribute(Boolean dbIsClusteredValue)

Sets the value of ODFDOM attribute representation DbIsClusteredAttribute , See @db:is-clustered

Parameters:

dbIsClusteredValue - The type is Boolean

getDbIsUniqueAttribute

public Boolean getDbIsUniqueAttribute()

Receives the value of the ODFDOM attribute representation DbIsUniqueAttribute , See @db:is-unique

Returns:

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

setDbIsUniqueAttribute

public void setDbIsUniqueAttribute(Boolean dbIsUniqueValue)

Sets the value of ODFDOM attribute representation DbIsUniqueAttribute , See @db:is-unique

Parameters:

dbIsUniqueValue - The type is Boolean

getDbNameAttribute

public String getDbNameAttribute()

Receives the value of the ODFDOM attribute representation DbNameAttribute , See @db:name

Attribute is mandatory.

Returns:

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

setDbNameAttribute

public void setDbNameAttribute(String dbNameValue)

Sets the value of ODFDOM attribute representation DbNameAttribute , See @db:name

Parameters:

dbNameValue - The type is String

newDbIndexColumnsElement

public DbIndexColumnsElement newDbIndexColumnsElement()

Create child element <db:index-columns>.

Child element is new in Odf 1.2

Child element is mandatory.

Returns:

the element <db:index-columns>

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