ShapeState (CIP4 xJdfLib 0.4 API)

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

All Implemented Interfaces:: Serializable

public class ShapeState
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>
         <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"/>
       </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="PresentZ" type="{http://www.CIP4.org/JDFSchema_2_0}NumberRangeList" />
       <attribute name="PresentY" type="{http://www.CIP4.org/JDFSchema_2_0}NumberRangeList" />
       <attribute name="PresentX" type="{http://www.CIP4.org/JDFSchema_2_0}NumberRangeList" />
       <attribute name="MaxOccurs" type="{http://www.CIP4.org/JDFSchema_2_0}unbounded" />
       <attribute name="CurrentValue" type="{http://www.CIP4.org/JDFSchema_2_0}shape" />
       <attribute name="PresentValueList" type="{http://www.CIP4.org/JDFSchema_2_0}ShapeRangeList" />
       <attribute name="ID" type="{http://www.CIP4.org/JDFSchema_2_0}ID" />
       <attribute name="AllowedValueList" type="{http://www.CIP4.org/JDFSchema_2_0}ShapeRangeList" />
       <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="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}shape" />
       <attribute name="AllowedY" type="{http://www.CIP4.org/JDFSchema_2_0}NumberRangeList" />
       <attribute name="AllowedX" type="{http://www.CIP4.org/JDFSchema_2_0}NumberRangeList" />
       <attribute name="AllowedZ" type="{http://www.CIP4.org/JDFSchema_2_0}NumberRangeList" />
       <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>`	`allowedValueList`
`protected List<Double>`	`allowedX`
`protected List<Double>`	`allowedY`
`protected List<Double>`	`allowedZ`
`protected EnumAvailability`	`availability`
`protected Shape`	`currentValue`
`protected Shape`	`defaultValue`
`protected Object`	`dependentMacroRef`
`protected String`	`descriptiveName`
`protected String`	`devNS`
`protected Boolean`	`editable`
`protected Boolean`	`hasDefault`
`protected String`	`id`
`protected EnumListType`	`listType`
`protected List<Loc>`	`loc`
`protected List<Object>`	`macroRefs`
`protected String`	`maxOccurs`
`protected Integer`	`minOccurs`
`protected List<Object>`	`moduleRefs`
`protected List<Double>`	`presentValueList`
`protected List<Double>`	`presentX`
`protected List<Double>`	`presentY`
`protected List<Double>`	`presentZ`
`protected Boolean`	`required`
`protected EnumUserDisplay`	`userDisplay`
`protected List<ValueLoc>`	`valueLoc`
`protected String`	`xPath`
`protected String`	`xPathRoot`

Constructor Summary

Constructors
Constructor and Description

ShapeState()

Constructors
Constructor and Description
`ShapeState()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<Object>`	`getActionRefs()` Gets the value of the actionRefs property.
`List<Double>`	`getAllowedValueList()` Gets the value of the allowedValueList property.
`List<Double>`	`getAllowedX()` Gets the value of the allowedX property.
`List<Double>`	`getAllowedY()` Gets the value of the allowedY property.
`List<Double>`	`getAllowedZ()` Gets the value of the allowedZ property.
`EnumAvailability`	`getAvailability()` Gets the value of the availability property.
`Shape`	`getCurrentValue()` Gets the value of the currentValue property.
`Shape`	`getDefaultValue()` Gets the value of the defaultValue 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>`	`getLoc()` Gets the value of the loc 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>`	`getPresentValueList()` Gets the value of the presentValueList property.
`List<Double>`	`getPresentX()` Gets the value of the presentX property.
`List<Double>`	`getPresentY()` Gets the value of the presentY property.
`List<Double>`	`getPresentZ()` Gets the value of the presentZ property.
`EnumUserDisplay`	`getUserDisplay()` Gets the value of the userDisplay property.
`List<ValueLoc>`	`getValueLoc()` Gets the value of the valueLoc 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`	`setAvailability(EnumAvailability value)` Sets the value of the availability property.
`void`	`setCurrentValue(Shape value)` Sets the value of the currentValue property.
`void`	`setDefaultValue(Shape value)` Sets the value of the defaultValue 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`	`setRequired(Boolean value)` Sets the value of the required 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
  - valueLoc
```
protected List<ValueLoc> valueLoc
```
  - loc
```
protected List<Loc> loc
```
  - userDisplay
```
protected EnumUserDisplay userDisplay
```
  - hasDefault
```
protected Boolean hasDefault
```
  - required
```
protected Boolean required
```
  - editable
```
protected Boolean editable
```
  - presentZ
```
protected List<Double> presentZ
```
  - presentY
```
protected List<Double> presentY
```
  - presentX
```
protected List<Double> presentX
```
  - maxOccurs
```
protected String maxOccurs
```
  - currentValue
```
protected Shape currentValue
```
  - presentValueList
```
protected List<Double> presentValueList
```
  - id
```
protected String id
```
  - allowedValueList
```
protected List<Double> allowedValueList
```
  - devNS
```
protected String devNS
```
  - availability
```
protected EnumAvailability availability
```
  - listType
```
protected EnumListType listType
```
  - minOccurs
```
protected Integer minOccurs
```
  - moduleRefs
```
protected List<Object> moduleRefs
```
  - macroRefs
```
protected List<Object> macroRefs
```
  - actionRefs
```
protected List<Object> actionRefs
```
  - dependentMacroRef
```
protected Object dependentMacroRef
```
  - defaultValue
```
protected Shape defaultValue
```
  - allowedY
```
protected List<Double> allowedY
```
  - allowedX
```
protected List<Double> allowedX
```
  - allowedZ
```
protected List<Double> allowedZ
```
  - xPath
```
protected String xPath
```
  - xPathRoot
```
protected String xPathRoot
```
  - descriptiveName
```
protected String descriptiveName
```
- Constructor Detail
  - ShapeState
```
public ShapeState()
```
- Method Detail
  - getValueLoc
```
public List<ValueLoc> getValueLoc()
```
    Gets the value of the valueLoc 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 valueLoc property.
    For example, to add a new item, do as follows:
```
    getValueLoc().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ValueLoc
  - getLoc
```
public List<Loc> getLoc()
```
    Gets the value of the loc 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 loc property.
    For example, to add a new item, do as follows:
```
    getLoc().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Loc
  - 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
  - getPresentZ
```
public List<Double> getPresentZ()
```
    Gets the value of the presentZ 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 presentZ property.
    For example, to add a new item, do as follows:
```
    getPresentZ().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - getPresentY
```
public List<Double> getPresentY()
```
    Gets the value of the presentY 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 presentY property.
    For example, to add a new item, do as follows:
```
    getPresentY().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - getPresentX
```
public List<Double> getPresentX()
```
    Gets the value of the presentX 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 presentX property.
    For example, to add a new item, do as follows:
```
    getPresentX().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - 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
  - getCurrentValue
```
public Shape getCurrentValue()
```
    Gets the value of the currentValue property.
    
    Returns:
    possible object is String
  - setCurrentValue
```
public void setCurrentValue(Shape value)
```
    Sets the value of the currentValue property.
    
    Parameters:
    value - allowed object is String
  - getPresentValueList
```
public List<Double> getPresentValueList()
```
    Gets the value of the presentValueList 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 presentValueList property.
    For example, to add a new item, do as follows:
```
    getPresentValueList().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
  - getAllowedValueList
```
public List<Double> getAllowedValueList()
```
    Gets the value of the allowedValueList 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 allowedValueList property.
    For example, to add a new item, do as follows:
```
    getAllowedValueList().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
  - 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
  - getDefaultValue
```
public Shape getDefaultValue()
```
    Gets the value of the defaultValue property.
    
    Returns:
    possible object is String
  - setDefaultValue
```
public void setDefaultValue(Shape value)
```
    Sets the value of the defaultValue property.
    
    Parameters:
    value - allowed object is String
  - getAllowedY
```
public List<Double> getAllowedY()
```
    Gets the value of the allowedY 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 allowedY property.
    For example, to add a new item, do as follows:
```
    getAllowedY().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - getAllowedX
```
public List<Double> getAllowedX()
```
    Gets the value of the allowedX 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 allowedX property.
    For example, to add a new item, do as follows:
```
    getAllowedX().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - getAllowedZ
```
public List<Double> getAllowedZ()
```
    Gets the value of the allowedZ 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 allowedZ property.
    For example, to add a new item, do as follows:
```
    getAllowedZ().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Double
  - 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 ShapeState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

valueLoc

loc

userDisplay

hasDefault

required

editable

presentZ

presentY

presentX

maxOccurs

currentValue

presentValueList

id

allowedValueList

devNS

availability

listType

minOccurs

moduleRefs

macroRefs

actionRefs

dependentMacroRef

defaultValue

allowedY

allowedX

allowedZ

xPath

xPathRoot

descriptiveName

Constructor Detail

ShapeState

Method Detail

getValueLoc

getLoc

getUserDisplay

setUserDisplay

isHasDefault

setHasDefault

isRequired

setRequired

isEditable

setEditable

getPresentZ

getPresentY

getPresentX

getMaxOccurs

setMaxOccurs

getCurrentValue

setCurrentValue

getPresentValueList

getID

setID

getAllowedValueList

getDevNS

setDevNS

getAvailability

setAvailability

getListType

setListType

getMinOccurs

setMinOccurs

getModuleRefs

getMacroRefs

getActionRefs

getDependentMacroRef

setDependentMacroRef

getDefaultValue

setDefaultValue

getAllowedY

getAllowedX

getAllowedZ

getXPath

setXPath

getXPathRoot