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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greenpepper-extensions-java Show documentation
The 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.pkg.OdfElement;
import org.odftoolkit.odfdom.pkg.ElementVisitor;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.attribute.table.TableDateEndAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableDateStartAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableEndAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableGroupedByAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableSourceFieldNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableStartAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableStepAttribute;

/**
 * DOM implementation of OpenDocument element  {@odf.element table:data-pilot-groups}.
 *
 */
public class TableDataPilotGroupsElement extends OdfElement {

	public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TABLE, "data-pilot-groups");

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

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

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

	/**
	 * Sets the value of ODFDOM attribute representation TableDateEndAttribute , See {@odf.attribute table:date-end}
	 *
	 * @param tableDateEndValue   The type is String
	 */
	public void setTableDateEndAttribute(String tableDateEndValue) {
		TableDateEndAttribute attr = new TableDateEndAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(tableDateEndValue);
	}

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

	/**
	 * Sets the value of ODFDOM attribute representation TableDateStartAttribute , See {@odf.attribute table:date-start}
	 *
	 * @param tableDateStartValue   The type is String
	 */
	public void setTableDateStartAttribute(String tableDateStartValue) {
		TableDateStartAttribute attr = new TableDateStartAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(tableDateStartValue);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TableEndAttribute , See {@odf.attribute table:end}
	 *
	 * @return - the Double , the value or null, if the attribute is not set and no default value defined.
	 */
	public Double getTableEndAttribute() {
		TableEndAttribute attr = (TableEndAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "end");
		if (attr != null) {
			return Double.valueOf(attr.doubleValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TableEndAttribute , See {@odf.attribute table:end}
	 *
	 * @param tableEndValue   The type is Double
	 */
	public void setTableEndAttribute(Double tableEndValue) {
		TableEndAttribute attr = new TableEndAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setDoubleValue(tableEndValue.doubleValue());
	}

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

	/**
	 * Sets the value of ODFDOM attribute representation TableGroupedByAttribute , See {@odf.attribute table:grouped-by}
	 *
	 * @param tableGroupedByValue   The type is String
	 */
	public void setTableGroupedByAttribute(String tableGroupedByValue) {
		TableGroupedByAttribute attr = new TableGroupedByAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(tableGroupedByValue);
	}

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

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

	/**
	 * Receives the value of the ODFDOM attribute representation TableStartAttribute , See {@odf.attribute table:start}
	 *
	 * @return - the Double , the value or null, if the attribute is not set and no default value defined.
	 */
	public Double getTableStartAttribute() {
		TableStartAttribute attr = (TableStartAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "start");
		if (attr != null) {
			return Double.valueOf(attr.doubleValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TableStartAttribute , See {@odf.attribute table:start}
	 *
	 * @param tableStartValue   The type is Double
	 */
	public void setTableStartAttribute(Double tableStartValue) {
		TableStartAttribute attr = new TableStartAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setDoubleValue(tableStartValue.doubleValue());
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TableStepAttribute , See {@odf.attribute table:step}
	 *
	 * Attribute is mandatory.
	 *
	 * @return - the Double , the value or null, if the attribute is not set and no default value defined.
	 */
	public Double getTableStepAttribute() {
		TableStepAttribute attr = (TableStepAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "step");
		if (attr != null) {
			return Double.valueOf(attr.doubleValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TableStepAttribute , See {@odf.attribute table:step}
	 *
	 * @param tableStepValue   The type is Double
	 */
	public void setTableStepAttribute(Double tableStepValue) {
		TableStepAttribute attr = new TableStepAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setDoubleValue(tableStepValue.doubleValue());
	}

	/**
	 * Create child element {@odf.element table:data-pilot-group}.
	 *
	 * @param tableNameValue  the String value of TableNameAttribute, see {@odf.attribute  table:name} at specification
	 * Child element is mandatory.
	 *
	 * @return the element {@odf.element table:data-pilot-group}
	 */
	 public TableDataPilotGroupElement newTableDataPilotGroupElement(String tableNameValue) {
		TableDataPilotGroupElement tableDataPilotGroup = ((OdfFileDom) this.ownerDocument).newOdfElement(TableDataPilotGroupElement.class);
		tableDataPilotGroup.setTableNameAttribute(tableNameValue);
		this.appendChild(tableDataPilotGroup);
		return tableDataPilotGroup;
	}

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