org.odftoolkit.odfdom.dom.element.text.TextDdeConnectionDeclElement 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.text;

import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeAutomaticUpdateAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeDdeApplicationAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeDdeItemAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeDdeTopicAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeNameAttribute;
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 text:dde-connection-decl}. */
public class TextDdeConnectionDeclElement extends OdfElement {

  public static final OdfName ELEMENT_NAME =
      OdfName.newName(OdfDocumentNamespace.TEXT, "dde-connection-decl");

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

  /**
   * Get the element name
   *
   * @return return OdfName the name of element {@odf.element
   *     text:dde-connection-decl}.
   */
  public OdfName getOdfName() {
    return ELEMENT_NAME;
  }

  /**
   * Receives the value of the ODFDOM attribute representation OfficeAutomaticUpdateAttribute
   *  , See {@odf.attribute office:automatic-update}
   *
   * @return - the Boolean , the value or null, if the attribute is not
   *     set and no default value defined.
   */
  public Boolean getOfficeAutomaticUpdateAttribute() {
    OfficeAutomaticUpdateAttribute attr =
        (OfficeAutomaticUpdateAttribute)
            getOdfAttribute(OdfDocumentNamespace.OFFICE, "automatic-update");
    if (attr != null && !attr.getValue().isEmpty()) {
      return Boolean.valueOf(attr.booleanValue());
    }
    return Boolean.valueOf(OfficeAutomaticUpdateAttribute.DEFAULT_VALUE);
  }

  /**
   * Sets the value of ODFDOM attribute representation OfficeAutomaticUpdateAttribute ,
   * See {@odf.attribute office:automatic-update}
   *
   * @param officeAutomaticUpdateValue The type is Boolean
   */
  public void setOfficeAutomaticUpdateAttribute(Boolean officeAutomaticUpdateValue) {
    OfficeAutomaticUpdateAttribute attr =
        new OfficeAutomaticUpdateAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setBooleanValue(officeAutomaticUpdateValue.booleanValue());
  }

  /**
   * Receives the value of the ODFDOM attribute representation OfficeDdeApplicationAttribute
   *  , See {@odf.attribute office:dde-application}
   *
   * 
Attribute is mandatory.
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getOfficeDdeApplicationAttribute() {
    OfficeDdeApplicationAttribute attr =
        (OfficeDdeApplicationAttribute)
            getOdfAttribute(OdfDocumentNamespace.OFFICE, "dde-application");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation OfficeDdeApplicationAttribute ,
   * See {@odf.attribute office:dde-application}
   *
   * @param officeDdeApplicationValue The type is String
   */
  public void setOfficeDdeApplicationAttribute(String officeDdeApplicationValue) {
    OfficeDdeApplicationAttribute attr =
        new OfficeDdeApplicationAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(officeDdeApplicationValue);
  }

  /**
   * Receives the value of the ODFDOM attribute representation OfficeDdeItemAttribute ,
   * See {@odf.attribute office:dde-item}
   *
   * 
Attribute is mandatory.
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getOfficeDdeItemAttribute() {
    OfficeDdeItemAttribute attr =
        (OfficeDdeItemAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "dde-item");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation OfficeDdeItemAttribute , See
   * {@odf.attribute office:dde-item}
   *
   * @param officeDdeItemValue The type is String
   */
  public void setOfficeDdeItemAttribute(String officeDdeItemValue) {
    OfficeDdeItemAttribute attr = new OfficeDdeItemAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(officeDdeItemValue);
  }

  /**
   * Receives the value of the ODFDOM attribute representation OfficeDdeTopicAttribute
   * , See {@odf.attribute office:dde-topic}
   *
   * 
Attribute is mandatory.
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getOfficeDdeTopicAttribute() {
    OfficeDdeTopicAttribute attr =
        (OfficeDdeTopicAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "dde-topic");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation OfficeDdeTopicAttribute , See
   * {@odf.attribute office:dde-topic}
   *
   * @param officeDdeTopicValue The type is String
   */
  public void setOfficeDdeTopicAttribute(String officeDdeTopicValue) {
    OfficeDdeTopicAttribute attr = new OfficeDdeTopicAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(officeDdeTopicValue);
  }

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

  /**
   * Sets the value of ODFDOM attribute representation OfficeNameAttribute , See
   * {@odf.attribute office:name}
   *
   * @param officeNameValue The type is String
   */
  public void setOfficeNameAttribute(String officeNameValue) {
    OfficeNameAttribute attr = new OfficeNameAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(officeNameValue);
  }

  /**
   * 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);
    }
  }
}