/************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
 *
 * Use is subject to license terms.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0. You can also
 * obtain a copy of the License at http://odftoolkit.org/docs/license.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ************************************************************************/

/*
 * This file is automatically generated.
 * Don't edit manually.
 */    

package org.odftoolkit.odfdom.dom.element.db;

import org.odftoolkit.odfdom.dom.OdfName;
import org.odftoolkit.odfdom.dom.OdfNamespace;
import org.odftoolkit.odfdom.doc.OdfFileDom;
import org.odftoolkit.odfdom.dom.element.OdfElement;
import org.odftoolkit.odfdom.dom.type.OdfBoolean;

;

/**
 * DOM implementation of OpenDocument element  {@odfLink db:index}.
 *
 */
public abstract class OdfIndexElement extends OdfElement
{        
    public static final OdfName ELEMENT_NAME = OdfName.get( OdfNamespace.DB, "index" );

    /**
     * Create the instance of OdfIndexElement 
     *
     *@param  aOwnerDoc     The type is OdfFileDom
     */
    public OdfIndexElement( OdfFileDom aOwnerDoc )
    {
        super( aOwnerDoc, ELEMENT_NAME );
    }

    /**
     * Get the element name 
     *
     *@return  return   the name of element {@odfLink db:index}.
     */
    public OdfName getOdfName()
    {
        return ELEMENT_NAME;
    }

    /**
     * Initialization of the mandatory attributes of {@link  OdfIndexElement}
     *
     *@param name  The mandatory attribute {@attributeName  db:name}" 
     *
     */
    public void init(String name)
    {
        setName( name );
    }

    /**
     * Get value of attribute {@attributeName db:name}.
     *
     *@return return the attribute which type is String
     */
    public String getName()
    {
        return getOdfAttribute( OdfName.get( OdfNamespace.DB, "name" ) );
    }

    /**
     * Set value of attribute {@attributeName db:name}.
     *
     *@param  name    the attribute's type is String
     */ 
     public void setName( String name )
    {
        setOdfAttribute( OdfName.get( OdfNamespace.DB, "name" ), name );
    }

    /**
     * Get value of attribute {@attributeName db:catalog-name}.
     *
     *@return return the attribute which type is String
     */
    public String getCatalogName()
    {
        return getOdfAttribute( OdfName.get( OdfNamespace.DB, "catalog-name" ) );
    }

    /**
     * Set value of attribute {@attributeName db:catalog-name}.
     *
     *@param  catalogName    the attribute's type is String
     */ 
     public void setCatalogName( String catalogName )
    {
        setOdfAttribute( OdfName.get( OdfNamespace.DB, "catalog-name" ), catalogName );
    }

    /**
     * Get value of attribute {@attributeName db:is-unique}.
     *
     *@return return the attribute which type is OdfBoolean
     */
    public OdfBoolean getIsUnique()
    {                    
        String stringVal = getOdfAttribute( OdfName.get( OdfNamespace.DB, "is-unique" ) );
        return OdfBoolean.valueOf( stringVal);
    }

    /**
     * Set value of attribute {@attributeName db:is-unique}.
     *
     *@param  isIsUnique    the attribute's type is OdfBoolean
     */ 
     public void setIsUnique( OdfBoolean isIsUnique )
    {                    
        setOdfAttribute( OdfName.get( OdfNamespace.DB, "is-unique" ), isIsUnique.toString() );
    }

    /**
     * Get value of attribute {@attributeName db:is-clustered}.
     *
     *@return return the attribute which type is OdfBoolean
     */
    public OdfBoolean getIsClustered()
    {                    
        String stringVal = getOdfAttribute( OdfName.get( OdfNamespace.DB, "is-clustered" ) );
        return OdfBoolean.valueOf( stringVal);
    }

    /**
     * Set value of attribute {@attributeName db:is-clustered}.
     *
     *@param  isIsClustered    the attribute's type is OdfBoolean
     */ 
     public void setIsClustered( OdfBoolean isIsClustered )
    {                    
        setOdfAttribute( OdfName.get( OdfNamespace.DB, "is-clustered" ), isIsClustered.toString() );
    }

    /**
    * Create child element {@odfLink db:index-columns}.
    *
    *@return   return  the element {@odfLink db:index-columns}
    */
    public OdfIndexColumnsElement createIndexColumnsElement()
    {
        OdfIndexColumnsElement  nIndexColumns = ((OdfFileDom)this.ownerDocument).createOdfElement(OdfIndexColumnsElement.class);
        this.appendChild( nIndexColumns);
        return  nIndexColumns;
    }                   
               
}
