All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.docbook.model.IndexTerm Maven / Gradle / Ivy

The newest version!

package org.docbook.model;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElementRef;
import javax.xml.bind.annotation.XmlElementRefs;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlEnumValue;
import javax.xml.bind.annotation.XmlID;
import javax.xml.bind.annotation.XmlIDREF;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.CollapsedStringAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.w3.xlink.Actuate;
import org.w3.xlink.Show;


/**
 * 

Java class for indexterm element declaration. * *

The following schema fragment specifies the expected content contained within this class. * *

 * <element name="indexterm">
 *   <complexType>
 *     <complexContent>
 *       <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *         <sequence>
 *           <element ref="{http://docbook.org/ns/docbook}primary" minOccurs="0"/>
 *           <choice minOccurs="0">
 *             <sequence>
 *               <element ref="{http://docbook.org/ns/docbook}secondary"/>
 *               <choice minOccurs="0">
 *                 <sequence>
 *                   <element ref="{http://docbook.org/ns/docbook}tertiary"/>
 *                   <choice minOccurs="0">
 *                     <element ref="{http://docbook.org/ns/docbook}see"/>
 *                     <element ref="{http://docbook.org/ns/docbook}seealso" maxOccurs="unbounded"/>
 *                   </choice>
 *                 </sequence>
 *                 <element ref="{http://docbook.org/ns/docbook}see"/>
 *                 <element ref="{http://docbook.org/ns/docbook}seealso" maxOccurs="unbounded"/>
 *               </choice>
 *             </sequence>
 *             <element ref="{http://docbook.org/ns/docbook}see"/>
 *             <element ref="{http://docbook.org/ns/docbook}seealso" maxOccurs="unbounded"/>
 *           </choice>
 *         </sequence>
 *         <attGroup ref="{http://docbook.org/ns/docbook}db.common.linking.attributes"/>
 *         <attGroup ref="{http://docbook.org/ns/docbook}db.common.attributes"/>
 *         <attribute name="role" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
 *         <attribute name="significance">
 *           <simpleType>
 *             <restriction base="{http://www.w3.org/2001/XMLSchema}token">
 *               <enumeration value="normal"/>
 *               <enumeration value="preferred"/>
 *             </restriction>
 *           </simpleType>
 *         </attribute>
 *         <attribute name="startref" type="{http://www.w3.org/2001/XMLSchema}IDREF" />
 *         <attribute name="zone" type="{http://www.w3.org/2001/XMLSchema}IDREFS" />
 *         <attribute name="pagenum" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
 *         <attribute name="scope">
 *           <simpleType>
 *             <restriction base="{http://www.w3.org/2001/XMLSchema}token">
 *               <enumeration value="all"/>
 *               <enumeration value="global"/>
 *               <enumeration value="local"/>
 *             </restriction>
 *           </simpleType>
 *         </attribute>
 *         <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
 *         <attribute name="class">
 *           <simpleType>
 *             <restriction base="{http://www.w3.org/2001/XMLSchema}token">
 *               <enumeration value="singular"/>
 *               <enumeration value="startofrange"/>
 *               <enumeration value="endofrange"/>
 *             </restriction>
 *           </simpleType>
 *         </attribute>
 *       </restriction>
 *     </complexContent>
 *   </complexType>
 * </element>
 * 
* * */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "", propOrder = { "content" }) @XmlRootElement(name = "indexterm") public class IndexTerm { @XmlElementRefs({ @XmlElementRef(name = "primary", namespace = "http://docbook.org/ns/docbook", type = Primary.class, required = false), @XmlElementRef(name = "secondary", namespace = "http://docbook.org/ns/docbook", type = Secondary.class, required = false), @XmlElementRef(name = "tertiary", namespace = "http://docbook.org/ns/docbook", type = Tertiary.class, required = false), @XmlElementRef(name = "see", namespace = "http://docbook.org/ns/docbook", type = See.class, required = false), @XmlElementRef(name = "seealso", namespace = "http://docbook.org/ns/docbook", type = Seealso.class, required = false) }) protected List content; @XmlAttribute(name = "role") @XmlSchemaType(name = "anySimpleType") protected String role; @XmlAttribute(name = "significance") protected IndexTerm.Significance significance; @XmlAttribute(name = "startref") @XmlIDREF @XmlSchemaType(name = "IDREF") protected Object startref; @XmlAttribute(name = "zone") @XmlIDREF @XmlSchemaType(name = "IDREFS") protected List zone; @XmlAttribute(name = "pagenum") @XmlSchemaType(name = "anySimpleType") protected String pagenum; @XmlAttribute(name = "scope") protected IndexTerm.Scope scope; @XmlAttribute(name = "type") @XmlSchemaType(name = "anySimpleType") protected String type; @XmlAttribute(name = "class") protected IndexTerm.ClassType clazz; @XmlAttribute(name = "linkend") @XmlIDREF @XmlSchemaType(name = "IDREF") protected Object linkend; @XmlAttribute(name = "href", namespace = "http://www.w3.org/1999/xlink") @XmlSchemaType(name = "anySimpleType") protected String href; @XmlAttribute(name = "type", namespace = "http://www.w3.org/1999/xlink") @XmlSchemaType(name = "anySimpleType") protected String xlinkType; @XmlAttribute(name = "role", namespace = "http://www.w3.org/1999/xlink") @XmlSchemaType(name = "anySimpleType") protected String xlinkRole; @XmlAttribute(name = "arcrole", namespace = "http://www.w3.org/1999/xlink") @XmlSchemaType(name = "anySimpleType") protected String arcrole; @XmlAttribute(name = "title", namespace = "http://www.w3.org/1999/xlink") @XmlSchemaType(name = "anySimpleType") protected String xlinkTitle; @XmlAttribute(name = "show", namespace = "http://www.w3.org/1999/xlink") protected Show show; @XmlAttribute(name = "actuate", namespace = "http://www.w3.org/1999/xlink") protected Actuate actuate; @XmlAttribute(name = "id", namespace = "http://www.w3.org/XML/1998/namespace") @XmlJavaTypeAdapter(CollapsedStringAdapter.class) @XmlID @XmlSchemaType(name = "ID") protected String id; @XmlAttribute(name = "version") @XmlSchemaType(name = "anySimpleType") protected String version; @XmlAttribute(name = "lang", namespace = "http://www.w3.org/XML/1998/namespace") @XmlSchemaType(name = "anySimpleType") protected String xmlLang; @XmlAttribute(name = "base", namespace = "http://www.w3.org/XML/1998/namespace") @XmlSchemaType(name = "anySimpleType") protected String base; @XmlAttribute(name = "remap") @XmlSchemaType(name = "anySimpleType") protected String remap; @XmlAttribute(name = "xreflabel") @XmlSchemaType(name = "anySimpleType") protected String xreflabel; @XmlAttribute(name = "revisionflag") protected RevisionFlag revisionflag; @XmlAttribute(name = "dir") protected Direction dir; @XmlAttribute(name = "arch") @XmlSchemaType(name = "anySimpleType") protected String arch; @XmlAttribute(name = "audience") @XmlSchemaType(name = "anySimpleType") protected String audience; @XmlAttribute(name = "condition") @XmlSchemaType(name = "anySimpleType") protected String condition; @XmlAttribute(name = "conformance") @XmlSchemaType(name = "anySimpleType") protected String conformance; @XmlAttribute(name = "os") @XmlSchemaType(name = "anySimpleType") protected String os; @XmlAttribute(name = "revision") @XmlSchemaType(name = "anySimpleType") protected String revisionAttribute; @XmlAttribute(name = "security") @XmlSchemaType(name = "anySimpleType") protected String security; @XmlAttribute(name = "userlevel") @XmlSchemaType(name = "anySimpleType") protected String userlevel; @XmlAttribute(name = "vendor") @XmlSchemaType(name = "anySimpleType") protected String vendor; @XmlAttribute(name = "wordsize") @XmlSchemaType(name = "anySimpleType") protected String wordsize; @XmlAttribute(name = "annotations") @XmlSchemaType(name = "anySimpleType") protected String annotations; /** * Gets the rest of the content model. * *

* You are getting this "catch-all" property because of the following reason: * The field name "See" is used by two different parts of a schema. See: * line 10313 of file:/Users/sfali/development/personal/alphasystem/docbook-2-docx/docbook-model/src/main/resources/docbook.xsd * line 10309 of file:/Users/sfali/development/personal/alphasystem/docbook-2-docx/docbook-model/src/main/resources/docbook.xsd *

* To get rid of this property, apply a property customization to one * of both of the following declarations to change their names: * Gets the value of the content property. * *

* This accessor method returns a reference to the live list, * not a snapshot. Therefore any modification you make to the * returned list will be present inside the JAXB object. * This is why there is not a set method for the content property. * *

* For example, to add a new item, do as follows: *

     *    getContent().add(newItem);
     * 
* * *

* Objects of the following type(s) are allowed in the list * {@link Primary } * {@link Secondary } * {@link Tertiary } * {@link See } * {@link Seealso } * * */ public List getContent() { if (content == null) { content = new ArrayList(); } return this.content; } /** * Gets the value of the role property. * * @return * possible object is * {@link String } * */ public String getRole() { return role; } /** * Sets the value of the role property. * * @param value * allowed object is * {@link String } * */ public void setRole(String value) { this.role = value; } /** * Gets the value of the significance property. * * @return * possible object is * {@link IndexTerm.Significance } * */ public IndexTerm.Significance getSignificance() { return significance; } /** * Sets the value of the significance property. * * @param value * allowed object is * {@link IndexTerm.Significance } * */ public void setSignificance(IndexTerm.Significance value) { this.significance = value; } /** * Gets the value of the startref property. * * @return * possible object is * {@link Object } * */ public Object getStartref() { return startref; } /** * Sets the value of the startref property. * * @param value * allowed object is * {@link Object } * */ public void setStartref(Object value) { this.startref = value; } /** * Gets the value of the zone property. * *

* This accessor method returns a reference to the live list, * not a snapshot. Therefore any modification you make to the * returned list will be present inside the JAXB object. * This is why there is not a set method for the zone property. * *

* For example, to add a new item, do as follows: *

     *    getZone().add(newItem);
     * 
* * *

* Objects of the following type(s) are allowed in the list * {@link Object } * * */ public List getZone() { if (zone == null) { zone = new ArrayList(); } return this.zone; } /** * Gets the value of the pagenum property. * * @return * possible object is * {@link String } * */ public String getPagenum() { return pagenum; } /** * Sets the value of the pagenum property. * * @param value * allowed object is * {@link String } * */ public void setPagenum(String value) { this.pagenum = value; } /** * Gets the value of the scope property. * * @return * possible object is * {@link IndexTerm.Scope } * */ public IndexTerm.Scope getScope() { return scope; } /** * Sets the value of the scope property. * * @param value * allowed object is * {@link IndexTerm.Scope } * */ public void setScope(IndexTerm.Scope value) { this.scope = value; } /** * Gets the value of the type property. * * @return * possible object is * {@link String } * */ public String getType() { return type; } /** * Sets the value of the type property. * * @param value * allowed object is * {@link String } * */ public void setType(String value) { this.type = value; } /** * Gets the value of the clazz property. * * @return * possible object is * {@link IndexTerm.ClassType } * */ public IndexTerm.ClassType getClazz() { return clazz; } /** * Sets the value of the clazz property. * * @param value * allowed object is * {@link IndexTerm.ClassType } * */ public void setClazz(IndexTerm.ClassType value) { this.clazz = value; } /** * Gets the value of the linkend property. * * @return * possible object is * {@link Object } * */ public Object getLinkend() { return linkend; } /** * Sets the value of the linkend property. * * @param value * allowed object is * {@link Object } * */ public void setLinkend(Object value) { this.linkend = value; } /** * Gets the value of the href property. * * @return * possible object is * {@link String } * */ public String getHref() { return href; } /** * Sets the value of the href property. * * @param value * allowed object is * {@link String } * */ public void setHref(String value) { this.href = value; } /** * Gets the value of the xlinkType property. * * @return * possible object is * {@link String } * */ public String getXlinkType() { return xlinkType; } /** * Sets the value of the xlinkType property. * * @param value * allowed object is * {@link String } * */ public void setXlinkType(String value) { this.xlinkType = value; } /** * Gets the value of the xlinkRole property. * * @return * possible object is * {@link String } * */ public String getXlinkRole() { return xlinkRole; } /** * Sets the value of the xlinkRole property. * * @param value * allowed object is * {@link String } * */ public void setXlinkRole(String value) { this.xlinkRole = value; } /** * Gets the value of the arcrole property. * * @return * possible object is * {@link String } * */ public String getArcrole() { return arcrole; } /** * Sets the value of the arcrole property. * * @param value * allowed object is * {@link String } * */ public void setArcrole(String value) { this.arcrole = value; } /** * Gets the value of the xlinkTitle property. * * @return * possible object is * {@link String } * */ public String getXlinkTitle() { return xlinkTitle; } /** * Sets the value of the xlinkTitle property. * * @param value * allowed object is * {@link String } * */ public void setXlinkTitle(String value) { this.xlinkTitle = value; } /** * Gets the value of the show property. * * @return * possible object is * {@link Show } * */ public Show getShow() { return show; } /** * Sets the value of the show property. * * @param value * allowed object is * {@link Show } * */ public void setShow(Show value) { this.show = value; } /** * Gets the value of the actuate property. * * @return * possible object is * {@link Actuate } * */ public Actuate getActuate() { return actuate; } /** * Sets the value of the actuate property. * * @param value * allowed object is * {@link Actuate } * */ public void setActuate(Actuate value) { this.actuate = value; } /** * Gets the value of the id property. * * @return * possible object is * {@link String } * */ public String getId() { return id; } /** * Sets the value of the id property. * * @param value * allowed object is * {@link String } * */ public void setId(String value) { this.id = value; } /** * Gets the value of the version property. * * @return * possible object is * {@link String } * */ public String getVersion() { return version; } /** * Sets the value of the version property. * * @param value * allowed object is * {@link String } * */ public void setVersion(String value) { this.version = value; } /** * Gets the value of the xmlLang property. * * @return * possible object is * {@link String } * */ public String getXmlLang() { return xmlLang; } /** * Sets the value of the xmlLang property. * * @param value * allowed object is * {@link String } * */ public void setXmlLang(String value) { this.xmlLang = value; } /** * Gets the value of the base property. * * @return * possible object is * {@link String } * */ public String getBase() { return base; } /** * Sets the value of the base property. * * @param value * allowed object is * {@link String } * */ public void setBase(String value) { this.base = value; } /** * Gets the value of the remap property. * * @return * possible object is * {@link String } * */ public String getRemap() { return remap; } /** * Sets the value of the remap property. * * @param value * allowed object is * {@link String } * */ public void setRemap(String value) { this.remap = value; } /** * Gets the value of the xreflabel property. * * @return * possible object is * {@link String } * */ public String getXreflabel() { return xreflabel; } /** * Sets the value of the xreflabel property. * * @param value * allowed object is * {@link String } * */ public void setXreflabel(String value) { this.xreflabel = value; } /** * Gets the value of the revisionflag property. * * @return * possible object is * {@link RevisionFlag } * */ public RevisionFlag getRevisionflag() { return revisionflag; } /** * Sets the value of the revisionflag property. * * @param value * allowed object is * {@link RevisionFlag } * */ public void setRevisionflag(RevisionFlag value) { this.revisionflag = value; } /** * Gets the value of the dir property. * * @return * possible object is * {@link Direction } * */ public Direction getDir() { return dir; } /** * Sets the value of the dir property. * * @param value * allowed object is * {@link Direction } * */ public void setDir(Direction value) { this.dir = value; } /** * Gets the value of the arch property. * * @return * possible object is * {@link String } * */ public String getArch() { return arch; } /** * Sets the value of the arch property. * * @param value * allowed object is * {@link String } * */ public void setArch(String value) { this.arch = value; } /** * Gets the value of the audience property. * * @return * possible object is * {@link String } * */ public String getAudience() { return audience; } /** * Sets the value of the audience property. * * @param value * allowed object is * {@link String } * */ public void setAudience(String value) { this.audience = value; } /** * Gets the value of the condition property. * * @return * possible object is * {@link String } * */ public String getCondition() { return condition; } /** * Sets the value of the condition property. * * @param value * allowed object is * {@link String } * */ public void setCondition(String value) { this.condition = value; } /** * Gets the value of the conformance property. * * @return * possible object is * {@link String } * */ public String getConformance() { return conformance; } /** * Sets the value of the conformance property. * * @param value * allowed object is * {@link String } * */ public void setConformance(String value) { this.conformance = value; } /** * Gets the value of the os property. * * @return * possible object is * {@link String } * */ public String getOs() { return os; } /** * Sets the value of the os property. * * @param value * allowed object is * {@link String } * */ public void setOs(String value) { this.os = value; } /** * Gets the value of the revisionAttribute property. * * @return * possible object is * {@link String } * */ public String getRevisionAttribute() { return revisionAttribute; } /** * Sets the value of the revisionAttribute property. * * @param value * allowed object is * {@link String } * */ public void setRevisionAttribute(String value) { this.revisionAttribute = value; } /** * Gets the value of the security property. * * @return * possible object is * {@link String } * */ public String getSecurity() { return security; } /** * Sets the value of the security property. * * @param value * allowed object is * {@link String } * */ public void setSecurity(String value) { this.security = value; } /** * Gets the value of the userlevel property. * * @return * possible object is * {@link String } * */ public String getUserlevel() { return userlevel; } /** * Sets the value of the userlevel property. * * @param value * allowed object is * {@link String } * */ public void setUserlevel(String value) { this.userlevel = value; } /** * Gets the value of the vendor property. * * @return * possible object is * {@link String } * */ public String getVendor() { return vendor; } /** * Sets the value of the vendor property. * * @param value * allowed object is * {@link String } * */ public void setVendor(String value) { this.vendor = value; } /** * Gets the value of the wordsize property. * * @return * possible object is * {@link String } * */ public String getWordsize() { return wordsize; } /** * Sets the value of the wordsize property. * * @param value * allowed object is * {@link String } * */ public void setWordsize(String value) { this.wordsize = value; } /** * Gets the value of the annotations property. * * @return * possible object is * {@link String } * */ public String getAnnotations() { return annotations; } /** * Sets the value of the annotations property. * * @param value * allowed object is * {@link String } * */ public void setAnnotations(String value) { this.annotations = value; } public IndexTerm withContent(Object... values) { if (values!= null) { for (Object value: values) { getContent().add(value); } } return this; } public IndexTerm withContent(Collection values) { if (values!= null) { getContent().addAll(values); } return this; } public IndexTerm withRole(String value) { setRole(value); return this; } public IndexTerm withSignificance(IndexTerm.Significance value) { setSignificance(value); return this; } public IndexTerm withStartref(Object value) { setStartref(value); return this; } public IndexTerm withZone(Object... values) { if (values!= null) { for (Object value: values) { getZone().add(value); } } return this; } public IndexTerm withZone(Collection values) { if (values!= null) { getZone().addAll(values); } return this; } public IndexTerm withPagenum(String value) { setPagenum(value); return this; } public IndexTerm withScope(IndexTerm.Scope value) { setScope(value); return this; } public IndexTerm withType(String value) { setType(value); return this; } public IndexTerm withClazz(IndexTerm.ClassType value) { setClazz(value); return this; } public IndexTerm withLinkend(Object value) { setLinkend(value); return this; } public IndexTerm withHref(String value) { setHref(value); return this; } public IndexTerm withXlinkType(String value) { setXlinkType(value); return this; } public IndexTerm withXlinkRole(String value) { setXlinkRole(value); return this; } public IndexTerm withArcrole(String value) { setArcrole(value); return this; } public IndexTerm withXlinkTitle(String value) { setXlinkTitle(value); return this; } public IndexTerm withShow(Show value) { setShow(value); return this; } public IndexTerm withActuate(Actuate value) { setActuate(value); return this; } public IndexTerm withId(String value) { setId(value); return this; } public IndexTerm withVersion(String value) { setVersion(value); return this; } public IndexTerm withXmlLang(String value) { setXmlLang(value); return this; } public IndexTerm withBase(String value) { setBase(value); return this; } public IndexTerm withRemap(String value) { setRemap(value); return this; } public IndexTerm withXreflabel(String value) { setXreflabel(value); return this; } public IndexTerm withRevisionflag(RevisionFlag value) { setRevisionflag(value); return this; } public IndexTerm withDir(Direction value) { setDir(value); return this; } public IndexTerm withArch(String value) { setArch(value); return this; } public IndexTerm withAudience(String value) { setAudience(value); return this; } public IndexTerm withCondition(String value) { setCondition(value); return this; } public IndexTerm withConformance(String value) { setConformance(value); return this; } public IndexTerm withOs(String value) { setOs(value); return this; } public IndexTerm withRevisionAttribute(String value) { setRevisionAttribute(value); return this; } public IndexTerm withSecurity(String value) { setSecurity(value); return this; } public IndexTerm withUserlevel(String value) { setUserlevel(value); return this; } public IndexTerm withVendor(String value) { setVendor(value); return this; } public IndexTerm withWordsize(String value) { setWordsize(value); return this; } public IndexTerm withAnnotations(String value) { setAnnotations(value); return this; } /** *

Java class for null. * *

The following schema fragment specifies the expected content contained within this class. *

*

     * <simpleType>
     *   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     *     <enumeration value="singular"/>
     *     <enumeration value="startofrange"/>
     *     <enumeration value="endofrange"/>
     *   </restriction>
     * </simpleType>
     * 
* */ @XmlType(name = "") @XmlEnum public enum ClassType { @XmlEnumValue("singular") SINGULAR("singular"), @XmlEnumValue("startofrange") STARTOFRANGE("startofrange"), @XmlEnumValue("endofrange") ENDOFRANGE("endofrange"); private final String value; ClassType(String v) { value = v; } public String value() { return value; } public static IndexTerm.ClassType fromValue(String v) { for (IndexTerm.ClassType c: IndexTerm.ClassType.values()) { if (c.value.equals(v)) { return c; } } throw new IllegalArgumentException(v); } } /** *

Java class for null. * *

The following schema fragment specifies the expected content contained within this class. *

*

     * <simpleType>
     *   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     *     <enumeration value="all"/>
     *     <enumeration value="global"/>
     *     <enumeration value="local"/>
     *   </restriction>
     * </simpleType>
     * 
* */ @XmlType(name = "") @XmlEnum public enum Scope { @XmlEnumValue("all") ALL("all"), @XmlEnumValue("global") GLOBAL("global"), @XmlEnumValue("local") LOCAL("local"); private final String value; Scope(String v) { value = v; } public String value() { return value; } public static IndexTerm.Scope fromValue(String v) { for (IndexTerm.Scope c: IndexTerm.Scope.values()) { if (c.value.equals(v)) { return c; } } throw new IllegalArgumentException(v); } } /** *

Java class for null. * *

The following schema fragment specifies the expected content contained within this class. *

*

     * <simpleType>
     *   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     *     <enumeration value="normal"/>
     *     <enumeration value="preferred"/>
     *   </restriction>
     * </simpleType>
     * 
* */ @XmlType(name = "") @XmlEnum public enum Significance { @XmlEnumValue("normal") NORMAL("normal"), @XmlEnumValue("preferred") PREFERRED("preferred"); private final String value; Significance(String v) { value = v; } public String value() { return value; } public static IndexTerm.Significance fromValue(String v) { for (IndexTerm.Significance c: IndexTerm.Significance.values()) { if (c.value.equals(v)) { return c; } } throw new IllegalArgumentException(v); } } }