OfficeDdeSourceElement.java

/**
 * **********************************************************************
 *
 * <p>DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * <p>Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * <p>Use is subject to license terms.
 *
 * <p>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
 *
 * <p>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.
 *
 * <p>See the License for the specific language governing permissions and limitations under the
 * License.
 *
 * <p>**********************************************************************
 */

/*
 * This file is automatically generated.
 * Don't edit manually.
 */
package org.odftoolkit.odfdom.dom.element.office;

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.OfficeConversionModeAttribute;
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 office:dde-source}. */
public class OfficeDdeSourceElement extends OdfElement {

  public static final OdfName ELEMENT_NAME =
      OdfName.newName(OdfDocumentNamespace.OFFICE, "dde-source");

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

  /**
   * Get the element name
   *
   * @return return <code>OdfName</code> the name of element {@odf.element office:dde-source}.
   */
  public OdfName getOdfName() {
    return ELEMENT_NAME;
  }

  /**
   * Receives the value of the ODFDOM attribute representation <code>OfficeAutomaticUpdateAttribute
   * </code> , See {@odf.attribute office:automatic-update}
   *
   * @return - the <code>Boolean</code> , the value or <code>null</code>, 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) {
      return Boolean.valueOf(attr.booleanValue());
    }
    return Boolean.valueOf(OfficeAutomaticUpdateAttribute.DEFAULT_VALUE);
  }

  /**
   * Sets the value of ODFDOM attribute representation <code>OfficeAutomaticUpdateAttribute</code> ,
   * See {@odf.attribute office:automatic-update}
   *
   * @param officeAutomaticUpdateValue The type is <code>Boolean</code>
   */
  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 <code>OfficeConversionModeAttribute
   * </code> , See {@odf.attribute office:conversion-mode}
   *
   * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
   *     and no default value defined.
   */
  public String getOfficeConversionModeAttribute() {
    OfficeConversionModeAttribute attr =
        (OfficeConversionModeAttribute)
            getOdfAttribute(OdfDocumentNamespace.OFFICE, "conversion-mode");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return OfficeConversionModeAttribute.DEFAULT_VALUE;
  }

  /**
   * Sets the value of ODFDOM attribute representation <code>OfficeConversionModeAttribute</code> ,
   * See {@odf.attribute office:conversion-mode}
   *
   * @param officeConversionModeValue The type is <code>String</code>
   */
  public void setOfficeConversionModeAttribute(String officeConversionModeValue) {
    OfficeConversionModeAttribute attr =
        new OfficeConversionModeAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(officeConversionModeValue);
  }

  /**
   * Receives the value of the ODFDOM attribute representation <code>OfficeDdeApplicationAttribute
   * </code> , See {@odf.attribute office:dde-application}
   *
   * <p>Attribute is mandatory.
   *
   * @return - the <code>String</code> , the value or <code>null</code>, 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 <code>OfficeDdeApplicationAttribute</code> ,
   * See {@odf.attribute office:dde-application}
   *
   * @param officeDdeApplicationValue The type is <code>String</code>
   */
  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 <code>OfficeDdeItemAttribute</code> ,
   * See {@odf.attribute office:dde-item}
   *
   * <p>Attribute is mandatory.
   *
   * @return - the <code>String</code> , the value or <code>null</code>, 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 <code>OfficeDdeItemAttribute</code> , See
   * {@odf.attribute office:dde-item}
   *
   * @param officeDdeItemValue The type is <code>String</code>
   */
  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 <code>OfficeDdeTopicAttribute</code>
   * , See {@odf.attribute office:dde-topic}
   *
   * <p>Attribute is mandatory.
   *
   * @return - the <code>String</code> , the value or <code>null</code>, 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 <code>OfficeDdeTopicAttribute</code> , See
   * {@odf.attribute office:dde-topic}
   *
   * @param officeDdeTopicValue The type is <code>String</code>
   */
  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 <code>OfficeNameAttribute</code> ,
   * See {@odf.attribute office:name}
   *
   * @return - the <code>String</code> , the value or <code>null</code>, 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 <code>OfficeNameAttribute</code> , See
   * {@odf.attribute office:name}
   *
   * @param officeNameValue The type is <code>String</code>
   */
  public void setOfficeNameAttribute(String officeNameValue) {
    OfficeNameAttribute attr = new OfficeNameAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(officeNameValue);
  }

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