org.odftoolkit.odfdom.dom.element.db.DbComponentElement Maven / Gradle / Ivy
Show all versions of odfdom-java Show documentation
/**
* **********************************************************************
*
* 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.db;
import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.db.DbAsTemplateAttribute;
import org.odftoolkit.odfdom.dom.attribute.db.DbDescriptionAttribute;
import org.odftoolkit.odfdom.dom.attribute.db.DbNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.db.DbTitleAttribute;
import org.odftoolkit.odfdom.dom.attribute.xlink.XlinkActuateAttribute;
import org.odftoolkit.odfdom.dom.attribute.xlink.XlinkHrefAttribute;
import org.odftoolkit.odfdom.dom.attribute.xlink.XlinkShowAttribute;
import org.odftoolkit.odfdom.dom.attribute.xlink.XlinkTypeAttribute;
import org.odftoolkit.odfdom.dom.element.math.MathMathElement;
import org.odftoolkit.odfdom.dom.element.office.OfficeDocumentElement;
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 db:component}. */
public class DbComponentElement extends OdfElement {
public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.DB, "component");
/**
* Create the instance of DbComponentElement
*
* @param ownerDoc The type is OdfFileDom
*/
public DbComponentElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element db:component}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation DbAsTemplateAttribute ,
* See {@odf.attribute db:as-template}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getDbAsTemplateAttribute() {
DbAsTemplateAttribute attr =
(DbAsTemplateAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "as-template");
if (attr != null) {
return Boolean.valueOf(attr.booleanValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation DbAsTemplateAttribute , See
* {@odf.attribute db:as-template}
*
* @param dbAsTemplateValue The type is Boolean
*/
public void setDbAsTemplateAttribute(Boolean dbAsTemplateValue) {
DbAsTemplateAttribute attr = new DbAsTemplateAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(dbAsTemplateValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation DbDescriptionAttribute ,
* See {@odf.attribute db:description}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getDbDescriptionAttribute() {
DbDescriptionAttribute attr =
(DbDescriptionAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "description");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation DbDescriptionAttribute , See
* {@odf.attribute db:description}
*
* @param dbDescriptionValue The type is String
*/
public void setDbDescriptionAttribute(String dbDescriptionValue) {
DbDescriptionAttribute attr = new DbDescriptionAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(dbDescriptionValue);
}
/**
* Receives the value of the ODFDOM attribute representation DbNameAttribute , See
* {@odf.attribute db:name}
*
*
Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getDbNameAttribute() {
DbNameAttribute attr = (DbNameAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation DbNameAttribute , See
* {@odf.attribute db:name}
*
* @param dbNameValue The type is String
*/
public void setDbNameAttribute(String dbNameValue) {
DbNameAttribute attr = new DbNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(dbNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation DbTitleAttribute , See
* {@odf.attribute db:title}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getDbTitleAttribute() {
DbTitleAttribute attr = (DbTitleAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "title");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation DbTitleAttribute , See
* {@odf.attribute db:title}
*
* @param dbTitleValue The type is String
*/
public void setDbTitleAttribute(String dbTitleValue) {
DbTitleAttribute attr = new DbTitleAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(dbTitleValue);
}
/**
* Receives the value of the ODFDOM attribute representation XlinkActuateAttribute ,
* See {@odf.attribute xlink:actuate}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXlinkActuateAttribute() {
XlinkActuateAttribute attr =
(XlinkActuateAttribute) getOdfAttribute(OdfDocumentNamespace.XLINK, "actuate");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation XlinkActuateAttribute , See
* {@odf.attribute xlink:actuate}
*
* @param xlinkActuateValue The type is String
*/
public void setXlinkActuateAttribute(String xlinkActuateValue) {
XlinkActuateAttribute attr = new XlinkActuateAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xlinkActuateValue);
}
/**
* Receives the value of the ODFDOM attribute representation XlinkHrefAttribute , See
* {@odf.attribute xlink:href}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXlinkHrefAttribute() {
XlinkHrefAttribute attr =
(XlinkHrefAttribute) getOdfAttribute(OdfDocumentNamespace.XLINK, "href");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation XlinkHrefAttribute , See
* {@odf.attribute xlink:href}
*
* @param xlinkHrefValue The type is String
*/
public void setXlinkHrefAttribute(String xlinkHrefValue) {
XlinkHrefAttribute attr = new XlinkHrefAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xlinkHrefValue);
}
/**
* Receives the value of the ODFDOM attribute representation XlinkShowAttribute , See
* {@odf.attribute xlink:show}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXlinkShowAttribute() {
XlinkShowAttribute attr =
(XlinkShowAttribute) getOdfAttribute(OdfDocumentNamespace.XLINK, "show");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation XlinkShowAttribute , See
* {@odf.attribute xlink:show}
*
* @param xlinkShowValue The type is String
*/
public void setXlinkShowAttribute(String xlinkShowValue) {
XlinkShowAttribute attr = new XlinkShowAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xlinkShowValue);
}
/**
* Receives the value of the ODFDOM attribute representation XlinkTypeAttribute , See
* {@odf.attribute xlink:type}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXlinkTypeAttribute() {
XlinkTypeAttribute attr =
(XlinkTypeAttribute) getOdfAttribute(OdfDocumentNamespace.XLINK, "type");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation XlinkTypeAttribute , See
* {@odf.attribute xlink:type}
*
* @param xlinkTypeValue The type is String
*/
public void setXlinkTypeAttribute(String xlinkTypeValue) {
XlinkTypeAttribute attr = new XlinkTypeAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xlinkTypeValue);
}
/**
* Create child element {@odf.element math:math}.
*
*
Child element is new in Odf 1.2
*
* @return the element {@odf.element math:math}
*/
public MathMathElement newMathMathElement() {
MathMathElement mathMath =
((OdfFileDom) this.ownerDocument).newOdfElement(MathMathElement.class);
this.appendChild(mathMath);
return mathMath;
}
/**
* Create child element {@odf.element office:document}.
*
* @param officeMimetypeValue the String value of OfficeMimetypeAttribute
* , see {@odf.attribute office:mimetype} at specification
* @param officeVersionValue the String value of OfficeVersionAttribute,
* see {@odf.attribute office:version} at specification Child element is new in Odf 1.2
* @return the element {@odf.element office:document}
*/
public OfficeDocumentElement newOfficeDocumentElement(
String officeMimetypeValue, String officeVersionValue) {
OfficeDocumentElement officeDocument =
((OdfFileDom) this.ownerDocument).newOdfElement(OfficeDocumentElement.class);
officeDocument.setOfficeMimetypeAttribute(officeMimetypeValue);
officeDocument.setOfficeVersionAttribute(officeVersionValue);
this.appendChild(officeDocument);
return officeDocument;
}
@Override
public void accept(ElementVisitor visitor) {
if (visitor instanceof DefaultElementVisitor) {
DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
defaultVisitor.visit(this);
} else {
visitor.visit(this);
}
}
}