org.odftoolkit.odfdom.dom.element.db.DbDriverSettingsElement 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: 0.8.11-incubating
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.db;

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.db.DbBaseDnAttribute;
import org.odftoolkit.odfdom.dom.attribute.db.DbIsFirstRowHeaderLineAttribute;
import org.odftoolkit.odfdom.dom.attribute.db.DbParameterNameSubstitutionAttribute;
import org.odftoolkit.odfdom.dom.attribute.db.DbShowDeletedAttribute;
import org.odftoolkit.odfdom.dom.attribute.db.DbSystemDriverSettingsAttribute;

/**
 * DOM implementation of OpenDocument element  {@odf.element db:driver-settings}.
 *
 */
public class DbDriverSettingsElement extends OdfElement {

	public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.DB, "driver-settings");

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

	/**
	 * Get the element name
	 *
	 * @return  return   OdfName the name of element {@odf.element db:driver-settings}.
	 */
	public OdfName getOdfName() {
		return ELEMENT_NAME;
	}

	/**
	 * Receives the value of the ODFDOM attribute representation DbBaseDnAttribute , See {@odf.attribute db:base-dn}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getDbBaseDnAttribute() {
		DbBaseDnAttribute attr = (DbBaseDnAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "base-dn");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation DbBaseDnAttribute , See {@odf.attribute db:base-dn}
	 *
	 * @param dbBaseDnValue   The type is String
	 */
	public void setDbBaseDnAttribute(String dbBaseDnValue) {
		DbBaseDnAttribute attr = new DbBaseDnAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(dbBaseDnValue);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation DbIsFirstRowHeaderLineAttribute , See {@odf.attribute db:is-first-row-header-line}
	 *
	 * @return - the Boolean , the value or null, if the attribute is not set and no default value defined.
	 */
	public Boolean getDbIsFirstRowHeaderLineAttribute() {
		DbIsFirstRowHeaderLineAttribute attr = (DbIsFirstRowHeaderLineAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "is-first-row-header-line");
		if (attr != null) {
			return Boolean.valueOf(attr.booleanValue());
		}
		return Boolean.valueOf(DbIsFirstRowHeaderLineAttribute.DEFAULT_VALUE);
	}

	/**
	 * Sets the value of ODFDOM attribute representation DbIsFirstRowHeaderLineAttribute , See {@odf.attribute db:is-first-row-header-line}
	 *
	 * @param dbIsFirstRowHeaderLineValue   The type is Boolean
	 */
	public void setDbIsFirstRowHeaderLineAttribute(Boolean dbIsFirstRowHeaderLineValue) {
		DbIsFirstRowHeaderLineAttribute attr = new DbIsFirstRowHeaderLineAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setBooleanValue(dbIsFirstRowHeaderLineValue.booleanValue());
	}

	/**
	 * Receives the value of the ODFDOM attribute representation DbParameterNameSubstitutionAttribute , See {@odf.attribute db:parameter-name-substitution}
	 *
	 * @return - the Boolean , the value or null, if the attribute is not set and no default value defined.
	 */
	public Boolean getDbParameterNameSubstitutionAttribute() {
		DbParameterNameSubstitutionAttribute attr = (DbParameterNameSubstitutionAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "parameter-name-substitution");
		if (attr != null) {
			return Boolean.valueOf(attr.booleanValue());
		}
		return Boolean.valueOf(DbParameterNameSubstitutionAttribute.DEFAULT_VALUE);
	}

	/**
	 * Sets the value of ODFDOM attribute representation DbParameterNameSubstitutionAttribute , See {@odf.attribute db:parameter-name-substitution}
	 *
	 * @param dbParameterNameSubstitutionValue   The type is Boolean
	 */
	public void setDbParameterNameSubstitutionAttribute(Boolean dbParameterNameSubstitutionValue) {
		DbParameterNameSubstitutionAttribute attr = new DbParameterNameSubstitutionAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setBooleanValue(dbParameterNameSubstitutionValue.booleanValue());
	}

	/**
	 * Receives the value of the ODFDOM attribute representation DbShowDeletedAttribute , See {@odf.attribute db:show-deleted}
	 *
	 * @return - the Boolean , the value or null, if the attribute is not set and no default value defined.
	 */
	public Boolean getDbShowDeletedAttribute() {
		DbShowDeletedAttribute attr = (DbShowDeletedAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "show-deleted");
		if (attr != null) {
			return Boolean.valueOf(attr.booleanValue());
		}
		return Boolean.valueOf(DbShowDeletedAttribute.DEFAULT_VALUE);
	}

	/**
	 * Sets the value of ODFDOM attribute representation DbShowDeletedAttribute , See {@odf.attribute db:show-deleted}
	 *
	 * @param dbShowDeletedValue   The type is Boolean
	 */
	public void setDbShowDeletedAttribute(Boolean dbShowDeletedValue) {
		DbShowDeletedAttribute attr = new DbShowDeletedAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setBooleanValue(dbShowDeletedValue.booleanValue());
	}

	/**
	 * Receives the value of the ODFDOM attribute representation DbSystemDriverSettingsAttribute , See {@odf.attribute db:system-driver-settings}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getDbSystemDriverSettingsAttribute() {
		DbSystemDriverSettingsAttribute attr = (DbSystemDriverSettingsAttribute) getOdfAttribute(OdfDocumentNamespace.DB, "system-driver-settings");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation DbSystemDriverSettingsAttribute , See {@odf.attribute db:system-driver-settings}
	 *
	 * @param dbSystemDriverSettingsValue   The type is String
	 */
	public void setDbSystemDriverSettingsAttribute(String dbSystemDriverSettingsValue) {
		DbSystemDriverSettingsAttribute attr = new DbSystemDriverSettingsAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(dbSystemDriverSettingsValue);
	}

	/**
	 * Create child element {@odf.element db:auto-increment}.
	 *
	 * Child element is new in Odf 1.2
	 *
	 * @return the element {@odf.element db:auto-increment}
	 */
	public DbAutoIncrementElement newDbAutoIncrementElement() {
		DbAutoIncrementElement dbAutoIncrement = ((OdfFileDom) this.ownerDocument).newOdfElement(DbAutoIncrementElement.class);
		this.appendChild(dbAutoIncrement);
		return dbAutoIncrement;
	}

	/**
	 * Create child element {@odf.element db:character-set}.
	 *
	 * Child element is new in Odf 1.2
	 *
	 * @return the element {@odf.element db:character-set}
	 */
	public DbCharacterSetElement newDbCharacterSetElement() {
		DbCharacterSetElement dbCharacterSet = ((OdfFileDom) this.ownerDocument).newOdfElement(DbCharacterSetElement.class);
		this.appendChild(dbCharacterSet);
		return dbCharacterSet;
	}

	/**
	 * Create child element {@odf.element db:delimiter}.
	 *
	 * Child element is new in Odf 1.2
	 *
	 * @return the element {@odf.element db:delimiter}
	 */
	public DbDelimiterElement newDbDelimiterElement() {
		DbDelimiterElement dbDelimiter = ((OdfFileDom) this.ownerDocument).newOdfElement(DbDelimiterElement.class);
		this.appendChild(dbDelimiter);
		return dbDelimiter;
	}

	/**
	 * Create child element {@odf.element db:table-settings}.
	 *
	 * Child element is new in Odf 1.2
	 *
	 * @return the element {@odf.element db:table-settings}
	 */
	public DbTableSettingsElement newDbTableSettingsElement() {
		DbTableSettingsElement dbTableSettings = ((OdfFileDom) this.ownerDocument).newOdfElement(DbTableSettingsElement.class);
		this.appendChild(dbTableSettings);
		return dbTableSettings;
	}

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