org.odftoolkit.odfdom.dom.element.table.TableSubtotalRuleElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of odfdom-java Show documentation

ODFDOM is an OpenDocument Format (ODF) framework. Its purpose is to provide an easy common way to create, access and manipulate ODF files, without requiring detailed knowledge of the ODF specification. It is designed to provide the ODF developer community with an easy lightwork programming API portable to any object-oriented language. The current reference implementation is written in Java.

There is a newer version: 1.0.0-BETA1

Show newest version

/**
 * **********************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * 
Copyright 2008, 2010 Oracle and/or its affiliates. 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.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.table.TableGroupByFieldNumberAttribute;
import org.odftoolkit.odfdom.pkg.ElementVisitor;
import org.odftoolkit.odfdom.pkg.OdfElement;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;

/** DOM implementation of OpenDocument element {@odf.element table:subtotal-rule}. */
public class TableSubtotalRuleElement extends OdfElement {

  public static final OdfName ELEMENT_NAME =
      OdfName.newName(OdfDocumentNamespace.TABLE, "subtotal-rule");

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

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

  /**
   * Receives the value of the ODFDOM attribute representation 
   * TableGroupByFieldNumberAttribute , See {@odf.attribute table:group-by-field-number}
   *
   * Attribute is mandatory.
   *
   * @return - the Integer , the value or null, if the attribute is not
   *     set and no default value defined.
   */
  public Integer getTableGroupByFieldNumberAttribute() {
    TableGroupByFieldNumberAttribute attr =
        (TableGroupByFieldNumberAttribute)
            getOdfAttribute(OdfDocumentNamespace.TABLE, "group-by-field-number");
    if (attr != null && !attr.getValue().isEmpty()) {
      return Integer.valueOf(attr.intValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation TableGroupByFieldNumberAttribute
   * , See {@odf.attribute table:group-by-field-number}
   *
   * @param tableGroupByFieldNumberValue The type is Integer
   */
  public void setTableGroupByFieldNumberAttribute(Integer tableGroupByFieldNumberValue) {
    TableGroupByFieldNumberAttribute attr =
        new TableGroupByFieldNumberAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setIntValue(tableGroupByFieldNumberValue.intValue());
  }

  /**
   * Create child element {@odf.element table:subtotal-field}.
   *
   * @param tableFieldNumberValue the Integer value of TableFieldNumberAttribute
   *     , see {@odf.attribute table:field-number} at specification
   * @param tableFunctionValue the String value of TableFunctionAttribute,
   *     see {@odf.attribute table:function} at specification
   * @return the element {@odf.element table:subtotal-field}
   */
  public TableSubtotalFieldElement newTableSubtotalFieldElement(
      int tableFieldNumberValue, String tableFunctionValue) {
    TableSubtotalFieldElement tableSubtotalField =
        ((OdfFileDom) this.ownerDocument).newOdfElement(TableSubtotalFieldElement.class);
    tableSubtotalField.setTableFieldNumberAttribute(tableFieldNumberValue);
    tableSubtotalField.setTableFunctionAttribute(tableFunctionValue);
    this.appendChild(tableSubtotalField);
    return tableSubtotalField;
  }

  /**
   * Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design
   * pattern to get a better understanding.
   *
   * @param visitor an instance of DefaultElementVisitor
   */
  @Override
  public void accept(ElementVisitor visitor) {
    if (visitor instanceof DefaultElementVisitor) {
      DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
      defaultVisitor.visit(this);
    } else {
      visitor.visit(this);
    }
  }
}