XYPairState (CIP4 xJdfLib 0.3 API)

java.lang.Object
- org.cip4.lib.xjdf.schema.XYPairState

All Implemented Interfaces:: Serializable

public class XYPairState
extends Object
implements Serializable

Java class for anonymous complex type.

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

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element ref="{http://www.CIP4.org/JDFSchema_2_0}ValueLoc" maxOccurs="unbounded" minOccurs="0"/>
           <element ref="{http://www.CIP4.org/JDFSchema_2_0}Loc" maxOccurs="unbounded" minOccurs="0"/>
         </choice>
       </sequence>
       <attribute name="UserDisplay" type="{http://www.CIP4.org/JDFSchema_2_0}EnumUserDisplay" />
       <attribute name="HasDefault" type="{http://www.CIP4.org/JDFSchema_2_0}boolean" />
       <attribute name="Required" type="{http://www.CIP4.org/JDFSchema_2_0}boolean" />
       <attribute name="Editable" type="{http://www.CIP4.org/JDFSchema_2_0}boolean" />
       <attribute name="MaxOccurs" type="{http://www.CIP4.org/JDFSchema_2_0}unbounded" />
       <attribute name="CurrentValue" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="AllowedXYRelation" type="{http://www.CIP4.org/JDFSchema_2_0}EnumXYRelation" />
       <attribute name="PresentValueList" type="{http://www.CIP4.org/JDFSchema_2_0}XYPairRangeList" />
       <attribute name="ID" type="{http://www.CIP4.org/JDFSchema_2_0}ID" />
       <attribute name="AllowedValueList" type="{http://www.CIP4.org/JDFSchema_2_0}XYPairRangeList" />
       <attribute name="DevNS" type="{http://www.CIP4.org/JDFSchema_2_0}URI" />
       <attribute name="Availability" type="{http://www.CIP4.org/JDFSchema_2_0}EnumAvailability" />
       <attribute name="ListType" type="{http://www.CIP4.org/JDFSchema_2_0}EnumListType" />
       <attribute name="MinOccurs" type="{http://www.CIP4.org/JDFSchema_2_0}integer" />
       <attribute name="UnitType" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKEN" />
       <attribute name="ModuleRefs" type="{http://www.CIP4.org/JDFSchema_2_0}IDREFS" />
       <attribute name="MacroRefs" type="{http://www.CIP4.org/JDFSchema_2_0}IDREFS" />
       <attribute name="ActionRefs" type="{http://www.CIP4.org/JDFSchema_2_0}IDREFS" />
       <attribute name="DependentMacroRef" type="{http://www.CIP4.org/JDFSchema_2_0}IDREF" />
       <attribute name="DefaultValue" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="PresentXYRelation" type="{http://www.CIP4.org/JDFSchema_2_0}EnumXYRelation" />
       <attribute name="XPath" use="required" type="{http://www.CIP4.org/JDFSchema_2_0}XPath" />
       <attribute name="XPathRoot" type="{http://www.CIP4.org/JDFSchema_2_0}XPath" />
       <attribute name="DescriptiveName" type="{http://www.CIP4.org/JDFSchema_2_0}string" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Object>`	`actionRefs`
`protected List<Double>`	`allowedValueLists`
`protected EnumXYRelation`	`allowedXYRelation`
`protected EnumAvailability`	`availability`
`protected List<Double>`	`currentValues`
`protected List<Double>`	`defaultValues`
`protected Object`	`dependentMacroRef`
`protected String`	`descriptiveName`
`protected String`	`devNS`
`protected Boolean`	`editable`
`protected Boolean`	`hasDefault`
`protected String`	`id`
`protected EnumListType`	`listType`
`protected List<Loc>`	`locs`
`protected List<Object>`	`macroRefs`
`protected String`	`maxOccurs`
`protected Integer`	`minOccurs`
`protected List<Object>`	`moduleRefs`
`protected List<Double>`	`presentValueLists`
`protected EnumXYRelation`	`presentXYRelation`
`protected Boolean`	`required`
`protected String`	`unitType`
`protected EnumUserDisplay`	`userDisplay`
`protected List<ValueLoc>`	`valueLocs`
`protected String`	`xPath`
`protected String`	`xPathRoot`

Constructor Summary

Constructors
Constructor and Description

XYPairState()

Constructors
Constructor and Description
`XYPairState()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<Object>`	`getActionRefs()` Gets the value of the actionRefs property.
`List<Double>`	`getAllowedValueLists()` Gets the value of the allowedValueLists property.
`EnumXYRelation`	`getAllowedXYRelation()` Gets the value of the allowedXYRelation property.
`EnumAvailability`	`getAvailability()` Gets the value of the availability property.
`List<Double>`	`getCurrentValues()` Gets the value of the currentValues property.
`List<Double>`	`getDefaultValues()` Gets the value of the defaultValues property.
`Object`	`getDependentMacroRef()` Gets the value of the dependentMacroRef property.
`String`	`getDescriptiveName()` Gets the value of the descriptiveName property.
`String`	`getDevNS()` Gets the value of the devNS property.
`String`	`getID()` Gets the value of the id property.
`EnumListType`	`getListType()` Gets the value of the listType property.
`List<Loc>`	`getLocs()` Gets the value of the locs property.
`List<Object>`	`getMacroRefs()` Gets the value of the macroRefs property.
`String`	`getMaxOccurs()` Gets the value of the maxOccurs property.
`Integer`	`getMinOccurs()` Gets the value of the minOccurs property.
`List<Object>`	`getModuleRefs()` Gets the value of the moduleRefs property.
`List<Double>`	`getPresentValueLists()` Gets the value of the presentValueLists property.
`EnumXYRelation`	`getPresentXYRelation()` Gets the value of the presentXYRelation property.
`String`	`getUnitType()` Gets the value of the unitType property.
`EnumUserDisplay`	`getUserDisplay()` Gets the value of the userDisplay property.
`List<ValueLoc>`	`getValueLocs()` Gets the value of the valueLocs property.
`String`	`getXPath()` Gets the value of the xPath property.
`String`	`getXPathRoot()` Gets the value of the xPathRoot property.
`Boolean`	`isEditable()` Gets the value of the editable property.
`Boolean`	`isHasDefault()` Gets the value of the hasDefault property.
`Boolean`	`isRequired()` Gets the value of the required property.
`void`	`setAllowedXYRelation(EnumXYRelation value)` Sets the value of the allowedXYRelation property.
`void`	`setAvailability(EnumAvailability value)` Sets the value of the availability property.
`void`	`setDependentMacroRef(Object value)` Sets the value of the dependentMacroRef property.
`void`	`setDescriptiveName(String value)` Sets the value of the descriptiveName property.
`void`	`setDevNS(String value)` Sets the value of the devNS property.
`void`	`setEditable(Boolean value)` Sets the value of the editable property.
`void`	`setHasDefault(Boolean value)` Sets the value of the hasDefault property.
`void`	`setID(String value)` Sets the value of the id property.
`void`	`setListType(EnumListType value)` Sets the value of the listType property.
`void`	`setMaxOccurs(String value)` Sets the value of the maxOccurs property.
`void`	`setMinOccurs(Integer value)` Sets the value of the minOccurs property.
`void`	`setPresentXYRelation(EnumXYRelation value)` Sets the value of the presentXYRelation property.
`void`	`setRequired(Boolean value)` Sets the value of the required property.
`void`	`setUnitType(String value)` Sets the value of the unitType property.
`void`	`setUserDisplay(EnumUserDisplay value)` Sets the value of the userDisplay property.
`void`	`setXPath(String value)` Sets the value of the xPath property.
`void`	`setXPathRoot(String value)` Sets the value of the xPathRoot property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - locs
```
protected List<Loc> locs
```
  - valueLocs
```
protected List<ValueLoc> valueLocs
```
  - userDisplay
```
protected EnumUserDisplay userDisplay
```
  - hasDefault
```
protected Boolean hasDefault
```
  - required
```
protected Boolean required
```
  - editable
```
protected Boolean editable
```
  - maxOccurs
```
protected String maxOccurs
```
  - currentValues
```
protected List<Double> currentValues
```
  - allowedXYRelation
```
protected EnumXYRelation allowedXYRelation
```
  - presentValueLists
```
protected List<Double> presentValueLists
```
  - id
```
protected String id
```
  - allowedValueLists
```
protected List<Double> allowedValueLists
```
  - devNS
```
protected String devNS
```
  - availability
```
protected EnumAvailability availability
```
  - listType
```
protected EnumListType listType
```
  - minOccurs
```
protected Integer minOccurs
```
  - unitType
```
protected String unitType
```
  - moduleRefs
```
protected List<Object> moduleRefs
```
  - macroRefs
```
protected List<Object> macroRefs
```
  - actionRefs
```
protected List<Object> actionRefs
```
  - dependentMacroRef
```
protected Object dependentMacroRef
```
  - defaultValues
```
protected List<Double> defaultValues
```
  - presentXYRelation
```
protected EnumXYRelation presentXYRelation
```
  - xPath
```
protected String xPath
```
  - xPathRoot
```
protected String xPathRoot
```
  - descriptiveName
```
protected String descriptiveName
```
- Constructor Detail
  - XYPairState
```
public XYPairState()
```
- Method Detail
  - getLocs
```
public List<Loc> getLocs()
```
    Gets the value of the locs 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 locs property.
    For example, to add a new item, do as follows:
```
    getLocs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Loc
  - getValueLocs
```
public List<ValueLoc> getValueLocs()
```
    Gets the value of the valueLocs 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 valueLocs property.
    For example, to add a new item, do as follows:
```
    getValueLocs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ValueLoc
  - getUserDisplay
```
public EnumUserDisplay getUserDisplay()
```
    Gets the value of the userDisplay property.
    
    Returns:
    possible object is EnumUserDisplay
  - setUserDisplay
```
public void setUserDisplay(EnumUserDisplay value)
```
    Sets the value of the userDisplay property.
    
    Parameters:
    value - allowed object is EnumUserDisplay
  - isHasDefault
```
public Boolean isHasDefault()
```
    Gets the value of the hasDefault property.
    
    Returns:
    possible object is Boolean
  - setHasDefault
```
public void setHasDefault(Boolean value)
```
    Sets the value of the hasDefault property.
    
    Parameters:
    value - allowed object is Boolean
  - isRequired
```
public Boolean isRequired()
```
    Gets the value of the required property.
    
    Returns:
    possible object is Boolean
  - setRequired
```
public void setRequired(Boolean value)
```
    Sets the value of the required property.
    
    Parameters:
    value - allowed object is Boolean
  - isEditable
```
public Boolean isEditable()
```
    Gets the value of the editable property.
    
    Returns:
    possible object is Boolean
  - setEditable
```
public void setEditable(Boolean value)
```
    Sets the value of the editable property.
    
    Parameters:
    value - allowed object is Boolean
  - getMaxOccurs
```
public String getMaxOccurs()
```
    Gets the value of the maxOccurs property.
    
    Returns:
    possible object is String
  - setMaxOccurs
```
public void setMaxOccurs(String value)
```
    Sets the value of the maxOccurs property.
    
    Parameters:
    value - allowed object is String
  - getCurrentValues
```
public List<Double> getCurrentValues()
```
    Gets the value of the currentValues 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 currentValues property.
    For example, to add a new item, do as follows:
```
    getCurrentValues().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - getAllowedXYRelation
```
public EnumXYRelation getAllowedXYRelation()
```
    Gets the value of the allowedXYRelation property.
    
    Returns:
    possible object is EnumXYRelation
  - setAllowedXYRelation
```
public void setAllowedXYRelation(EnumXYRelation value)
```
    Sets the value of the allowedXYRelation property.
    
    Parameters:
    value - allowed object is EnumXYRelation
  - getPresentValueLists
```
public List<Double> getPresentValueLists()
```
    Gets the value of the presentValueLists 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 presentValueLists property.
    For example, to add a new item, do as follows:
```
    getPresentValueLists().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - getID
```
public String getID()
```
    Gets the value of the id property.
    
    Returns:
    possible object is String
  - setID
```
public void setID(String value)
```
    Sets the value of the id property.
    
    Parameters:
    value - allowed object is String
  - getAllowedValueLists
```
public List<Double> getAllowedValueLists()
```
    Gets the value of the allowedValueLists 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 allowedValueLists property.
    For example, to add a new item, do as follows:
```
    getAllowedValueLists().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - getDevNS
```
public String getDevNS()
```
    Gets the value of the devNS property.
    
    Returns:
    possible object is String
  - setDevNS
```
public void setDevNS(String value)
```
    Sets the value of the devNS property.
    
    Parameters:
    value - allowed object is String
  - getAvailability
```
public EnumAvailability getAvailability()
```
    Gets the value of the availability property.
    
    Returns:
    possible object is EnumAvailability
  - setAvailability
```
public void setAvailability(EnumAvailability value)
```
    Sets the value of the availability property.
    
    Parameters:
    value - allowed object is EnumAvailability
  - getListType
```
public EnumListType getListType()
```
    Gets the value of the listType property.
    
    Returns:
    possible object is EnumListType
  - setListType
```
public void setListType(EnumListType value)
```
    Sets the value of the listType property.
    
    Parameters:
    value - allowed object is EnumListType
  - getMinOccurs
```
public Integer getMinOccurs()
```
    Gets the value of the minOccurs property.
    
    Returns:
    possible object is Integer
  - setMinOccurs
```
public void setMinOccurs(Integer value)
```
    Sets the value of the minOccurs property.
    
    Parameters:
    value - allowed object is Integer
  - getUnitType
```
public String getUnitType()
```
    Gets the value of the unitType property.
    
    Returns:
    possible object is String
  - setUnitType
```
public void setUnitType(String value)
```
    Sets the value of the unitType property.
    
    Parameters:
    value - allowed object is String
  - getModuleRefs
```
public List<Object> getModuleRefs()
```
    Gets the value of the moduleRefs 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 moduleRefs property.
    For example, to add a new item, do as follows:
```
    getModuleRefs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Object
  - getMacroRefs
```
public List<Object> getMacroRefs()
```
    Gets the value of the macroRefs 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 macroRefs property.
    For example, to add a new item, do as follows:
```
    getMacroRefs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Object
  - getActionRefs
```
public List<Object> getActionRefs()
```
    Gets the value of the actionRefs 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 actionRefs property.
    For example, to add a new item, do as follows:
```
    getActionRefs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Object
  - getDependentMacroRef
```
public Object getDependentMacroRef()
```
    Gets the value of the dependentMacroRef property.
    
    Returns:
    possible object is Object
  - setDependentMacroRef
```
public void setDependentMacroRef(Object value)
```
    Sets the value of the dependentMacroRef property.
    
    Parameters:
    value - allowed object is Object
  - getDefaultValues
```
public List<Double> getDefaultValues()
```
    Gets the value of the defaultValues 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 defaultValues property.
    For example, to add a new item, do as follows:
```
    getDefaultValues().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - getPresentXYRelation
```
public EnumXYRelation getPresentXYRelation()
```
    Gets the value of the presentXYRelation property.
    
    Returns:
    possible object is EnumXYRelation
  - setPresentXYRelation
```
public void setPresentXYRelation(EnumXYRelation value)
```
    Sets the value of the presentXYRelation property.
    
    Parameters:
    value - allowed object is EnumXYRelation
  - getXPath
```
public String getXPath()
```
    Gets the value of the xPath property.
    
    Returns:
    possible object is String
  - setXPath
```
public void setXPath(String value)
```
    Sets the value of the xPath property.
    
    Parameters:
    value - allowed object is String
  - getXPathRoot
```
public String getXPathRoot()
```
    Gets the value of the xPathRoot property.
    
    Returns:
    possible object is String
  - setXPathRoot
```
public void setXPathRoot(String value)
```
    Sets the value of the xPathRoot property.
    
    Parameters:
    value - allowed object is String
  - getDescriptiveName
```
public String getDescriptiveName()
```
    Gets the value of the descriptiveName property.
    
    Returns:
    possible object is String
  - setDescriptiveName
```
public void setDescriptiveName(String value)
```
    Sets the value of the descriptiveName property.
    
    Parameters:
    value - allowed object is String

Class XYPairState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

locs

valueLocs

userDisplay

hasDefault

required

editable

maxOccurs

currentValues

allowedXYRelation

presentValueLists

id

allowedValueLists

devNS

availability

listType

minOccurs

unitType

moduleRefs

macroRefs

actionRefs

dependentMacroRef

defaultValues

presentXYRelation

xPath

xPathRoot

descriptiveName

Constructor Detail

XYPairState

Method Detail

getLocs

getValueLocs

getUserDisplay

setUserDisplay

isHasDefault

setHasDefault

isRequired

setRequired

isEditable

setEditable

getMaxOccurs

setMaxOccurs

getCurrentValues

getAllowedXYRelation

setAllowedXYRelation

getPresentValueLists

getID

setID

getAllowedValueLists

getDevNS

setDevNS

getAvailability

setAvailability

getListType

setListType

getMinOccurs

setMinOccurs

getUnitType

setUnitType

getModuleRefs

getMacroRefs

getActionRefs

getDependentMacroRef

setDependentMacroRef

getDefaultValues

getPresentXYRelation

setPresentXYRelation

getXPath

setXPath

getXPathRoot

setXPathRoot

getDescriptiveName

setDescriptiveName