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:

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • DbIndexElement

      public DbIndexElement(OdfFileDom ownerDoc)
      Create the instance of DbIndexElement
      Parameters:
      ownerDoc - The type is OdfFileDom

  • Method Details

    • 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 was added in ODF 1.2

      Child element is mandatory.

      Returns:
      the element <db:index-columns>

    • accept

      public void accept(ElementVisitor visitor)
      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