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

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.TableConditionSourceAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableConditionSourceRangeAddressAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableDisplayDuplicatesAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableTargetRangeAddressAttribute;
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:filter}. */
public class TableFilterElement extends OdfElement {

  public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TABLE, "filter");

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

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

  /**
   * Receives the value of the ODFDOM attribute representation TableConditionSourceAttribute
   *  , See {@odf.attribute table:condition-source}
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getTableConditionSourceAttribute() {
    TableConditionSourceAttribute attr =
        (TableConditionSourceAttribute)
            getOdfAttribute(OdfDocumentNamespace.TABLE, "condition-source");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return TableConditionSourceAttribute.DEFAULT_VALUE;
  }

  /**
   * Sets the value of ODFDOM attribute representation TableConditionSourceAttribute ,
   * See {@odf.attribute table:condition-source}
   *
   * @param tableConditionSourceValue The type is String
   */
  public void setTableConditionSourceAttribute(String tableConditionSourceValue) {
    TableConditionSourceAttribute attr =
        new TableConditionSourceAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(tableConditionSourceValue);
  }

  /**
   * Receives the value of the ODFDOM attribute representation 
   * TableConditionSourceRangeAddressAttribute , See {@odf.attribute
   * table:condition-source-range-address}
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getTableConditionSourceRangeAddressAttribute() {
    TableConditionSourceRangeAddressAttribute attr =
        (TableConditionSourceRangeAddressAttribute)
            getOdfAttribute(OdfDocumentNamespace.TABLE, "condition-source-range-address");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation 
   * TableConditionSourceRangeAddressAttribute , See {@odf.attribute
   * table:condition-source-range-address}
   *
   * @param tableConditionSourceRangeAddressValue The type is String
   */
  public void setTableConditionSourceRangeAddressAttribute(
      String tableConditionSourceRangeAddressValue) {
    TableConditionSourceRangeAddressAttribute attr =
        new TableConditionSourceRangeAddressAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(tableConditionSourceRangeAddressValue);
  }

  /**
   * Receives the value of the ODFDOM attribute representation TableDisplayDuplicatesAttribute
   *  , See {@odf.attribute table:display-duplicates}
   *
   * @return - the Boolean , the value or null, if the attribute is not
   *     set and no default value defined.
   */
  public Boolean getTableDisplayDuplicatesAttribute() {
    TableDisplayDuplicatesAttribute attr =
        (TableDisplayDuplicatesAttribute)
            getOdfAttribute(OdfDocumentNamespace.TABLE, "display-duplicates");
    if (attr != null) {
      return Boolean.valueOf(attr.booleanValue());
    }
    return Boolean.valueOf(TableDisplayDuplicatesAttribute.DEFAULT_VALUE);
  }

  /**
   * Sets the value of ODFDOM attribute representation TableDisplayDuplicatesAttribute
   * , See {@odf.attribute table:display-duplicates}
   *
   * @param tableDisplayDuplicatesValue The type is Boolean
   */
  public void setTableDisplayDuplicatesAttribute(Boolean tableDisplayDuplicatesValue) {
    TableDisplayDuplicatesAttribute attr =
        new TableDisplayDuplicatesAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setBooleanValue(tableDisplayDuplicatesValue.booleanValue());
  }

  /**
   * Receives the value of the ODFDOM attribute representation 
   * TableTargetRangeAddressAttribute , See {@odf.attribute table:target-range-address}
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getTableTargetRangeAddressAttribute() {
    TableTargetRangeAddressAttribute attr =
        (TableTargetRangeAddressAttribute)
            getOdfAttribute(OdfDocumentNamespace.TABLE, "target-range-address");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation TableTargetRangeAddressAttribute
   * , See {@odf.attribute table:target-range-address}
   *
   * @param tableTargetRangeAddressValue The type is String
   */
  public void setTableTargetRangeAddressAttribute(String tableTargetRangeAddressValue) {
    TableTargetRangeAddressAttribute attr =
        new TableTargetRangeAddressAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(tableTargetRangeAddressValue);
  }

  /**
   * Create child element {@odf.element table:filter-and}.
   *
   * @return the element {@odf.element table:filter-and}
   */
  public TableFilterAndElement newTableFilterAndElement() {
    TableFilterAndElement tableFilterAnd =
        ((OdfFileDom) this.ownerDocument).newOdfElement(TableFilterAndElement.class);
    this.appendChild(tableFilterAnd);
    return tableFilterAnd;
  }

  /**
   * Create child element {@odf.element table:filter-condition}.
   *
   * @param tableFieldNumberValue the Integer value of TableFieldNumberAttribute
   *     , see {@odf.attribute table:field-number} at specification
   * @param tableOperatorValue the String value of TableOperatorAttribute,
   *     see {@odf.attribute table:operator} at specification
   * @param tableValueValue the String value of TableValueAttribute, see
   *     {@odf.attribute table:value} at specification
   * @return the element {@odf.element table:filter-condition}
   */
  public TableFilterConditionElement newTableFilterConditionElement(
      int tableFieldNumberValue, String tableOperatorValue, String tableValueValue) {
    TableFilterConditionElement tableFilterCondition =
        ((OdfFileDom) this.ownerDocument).newOdfElement(TableFilterConditionElement.class);
    tableFilterCondition.setTableFieldNumberAttribute(tableFieldNumberValue);
    tableFilterCondition.setTableOperatorAttribute(tableOperatorValue);
    tableFilterCondition.setTableValueAttribute(tableValueValue);
    this.appendChild(tableFilterCondition);
    return tableFilterCondition;
  }

  /**
   * Create child element {@odf.element table:filter-or}.
   *
   * @return the element {@odf.element table:filter-or}
   */
  public TableFilterOrElement newTableFilterOrElement() {
    TableFilterOrElement tableFilterOr =
        ((OdfFileDom) this.ownerDocument).newOdfElement(TableFilterOrElement.class);
    this.appendChild(tableFilterOr);
    return tableFilterOr;
  }

  @Override
  public void accept(ElementVisitor visitor) {
    if (visitor instanceof DefaultElementVisitor) {
      DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
      defaultVisitor.visit(this);
    } else {
      visitor.visit(this);
    }
  }
}