/************************************************************************
 *
 * 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.table;

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.OdfNonNegativeInteger;

;

/**
 * DOM implementation of OpenDocument element  {@odfLink table:subtotal-rule}.
 *
 */
public abstract class OdfSubtotalRuleElement extends OdfElement
{        
    public static final OdfName ELEMENT_NAME = OdfName.get( OdfNamespace.TABLE, "subtotal-rule" );

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

    /**
     * Get the element name 
     *
     *@return  return   the name of element {@odfLink table:subtotal-rule}.
     */
    public OdfName getOdfName()
    {
        return ELEMENT_NAME;
    }

    /**
     * Initialization of the mandatory attributes of {@link  OdfSubtotalRuleElement}
     *
     *@param groupByFieldNumber  The mandatory attribute {@attributeName  table:group-by-field-number}" 
     *
     */
    public void init(OdfNonNegativeInteger groupByFieldNumber)
    {
        setGroupByFieldNumber( groupByFieldNumber );
    }

    /**
     * Get value of attribute {@attributeName table:group-by-field-number}.
     *
     *@return return the attribute which type is OdfNonNegativeInteger
     */
    public OdfNonNegativeInteger getGroupByFieldNumber()
    {                    
        String stringVal = getOdfAttribute( OdfName.get( OdfNamespace.TABLE, "group-by-field-number" ) );
        return OdfNonNegativeInteger.valueOf( stringVal);
    }

    /**
     * Set value of attribute {@attributeName table:group-by-field-number}.
     *
     *@param  groupByFieldNumber    the attribute's type is OdfNonNegativeInteger
     */ 
     public void setGroupByFieldNumber( OdfNonNegativeInteger groupByFieldNumber )
    {                    
        setOdfAttribute( OdfName.get( OdfNamespace.TABLE, "group-by-field-number" ), groupByFieldNumber.toString() );
    }

    /**
    * Create child element {@odfLink table:subtotal-field}.
    *
    *@param fieldNumber  the attribute's type is org.odftoolkit.odfdom.dom.type.OdfNonNegativeInteger
    *@param function String   
    *@return   return  the element {@odfLink table:subtotal-field}
    */
    public OdfSubtotalFieldElement createSubtotalFieldElement(org.odftoolkit.odfdom.dom.type.OdfNonNegativeInteger   fieldNumber, String   function)
    {
        OdfSubtotalFieldElement  nSubtotalField = ((OdfFileDom)this.ownerDocument).createOdfElement(OdfSubtotalFieldElement.class);
        nSubtotalField.setFieldNumber( fieldNumber);
        nSubtotalField.setFunction( function);
        this.appendChild( nSubtotalField);
        return  nSubtotalField;      
    }
    
}
