org.odftoolkit.odfdom.dom.attribute.text.TextBibliographyDataFieldAttribute 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.attribute.text;

import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.pkg.OdfAttribute;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;

/** DOM implementation of OpenDocument attribute {@odf.attribute text:bibliography-data-field}. */
public class TextBibliographyDataFieldAttribute extends OdfAttribute {

  public static final OdfName ATTRIBUTE_NAME =
      OdfName.newName(OdfDocumentNamespace.TEXT, "bibliography-data-field");

  /**
   * Create the instance of OpenDocument attribute {@odf.attribute text:bibliography-data-field}.
   *
   * @param ownerDocument The type is OdfFileDom
   */
  public TextBibliographyDataFieldAttribute(OdfFileDom ownerDocument) {
    super(ownerDocument, ATTRIBUTE_NAME);
  }

  /**
   * Returns the attribute name.
   *
   * @return the OdfName for {@odf.attribute text:bibliography-data-field}.
   */
  @Override
  public OdfName getOdfName() {
    return ATTRIBUTE_NAME;
  }

  /** @return Returns the name of this attribute. */
  @Override
  public String getName() {
    return ATTRIBUTE_NAME.getLocalName();
  }

  /** The value set of {@odf.attribute text:bibliography-data-field}. */
  public enum Value {
    ADDRESS("address"),
    ANNOTE("annote"),
    AUTHOR("author"),
    BIBLIOGRAPHY_TYPE("bibliography-type"),
    BOOKTITLE("booktitle"),
    CHAPTER("chapter"),
    CUSTOM1("custom1"),
    CUSTOM2("custom2"),
    CUSTOM3("custom3"),
    CUSTOM4("custom4"),
    CUSTOM5("custom5"),
    EDITION("edition"),
    EDITOR("editor"),
    HOWPUBLISHED("howpublished"),
    IDENTIFIER("identifier"),
    INSTITUTION("institution"),
    ISBN("isbn"),
    ISSN("issn"),
    JOURNAL("journal"),
    MONTH("month"),
    NOTE("note"),
    NUMBER("number"),
    ORGANIZATIONS("organizations"),
    PAGES("pages"),
    PUBLISHER("publisher"),
    REPORT_TYPE("report-type"),
    SCHOOL("school"),
    SERIES("series"),
    TITLE("title"),
    URL("url"),
    VOLUME("volume"),
    YEAR("year");

    private String mValue;

    Value(String value) {
      mValue = value;
    }

    @Override
    public String toString() {
      return mValue;
    }

    public static Value enumValueOf(String value) {
      for (Value aIter : values()) {
        if (value.equals(aIter.toString())) {
          return aIter;
        }
      }
      return null;
    }
  }

  /** @param attrValue The Enum value of the attribute. */
  public void setEnumValue(Value attrValue) {
    setValue(attrValue.toString());
  }

  /** @return Returns the Enum value of the attribute */
  public Value getEnumValue() {
    return Value.enumValueOf(this.getValue());
  }

  /**
   * Returns the default value of {@odf.attribute text:bibliography-data-field}.
   *
   * @return the default value as String dependent of its element name return 
   *     null if the default value does not exist
   */
  @Override
  public String getDefault() {
    return null;
  }

  /**
   * Default value indicator. As the attribute default value is dependent from its element, the
   * attribute has only a default, when a parent element exists.
   *
   * @return true if {@odf.attribute text:bibliography-data-field} has an element
   *     parent otherwise return false as undefined.
   */
  @Override
  public boolean hasDefault() {
    return false;
  }

  /** @return Returns whether this attribute is known to be of type ID (i.e. xml:id ?) */
  @Override
  public boolean isId() {
    return false;
  }
}