Package org.cip4.jdflib.resource.devicecapability

Class JDFStringState

java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.ElementImpl
org.apache.xerces.dom.ElementNSImpl
org.cip4.jdflib.core.KElement
org.cip4.jdflib.core.JDFElement
org.cip4.jdflib.resource.devicecapability.JDFAbstractState
org.cip4.jdflib.resource.devicecapability.JDFStringState
All Implemented Interfaces:
Serializable, Cloneable, JDFBaseDataTypes, ICapabilityElement, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class JDFStringState extends JDFAbstractState
See Also:

  • Constructor Details

    • JDFStringState

      public JDFStringState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
      constructor for JDFStringState
      Parameters:
      myOwnerDocument -
      qualifiedName -

    • JDFStringState

      public JDFStringState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
      constructor for JDFStringState
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -

    • JDFStringState

      public JDFStringState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
      constructor for JDFStringState
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -
      myLocalName -

  • Method Details

    • getTheAttributeInfo

      protected AttributeInfo getTheAttributeInfo()
      Overrides:
      getTheAttributeInfo in class JDFAbstractState
      Returns:

    • getTheElementInfo

      protected ElementInfo getTheElementInfo()
      Overrides:
      getTheElementInfo in class JDFAbstractState
      Returns:
      the elementinfo

    • toString

      public String toString()
      toString
      Overrides:
      toString in class KElement
      Returns:
      String
      See Also:

    • setCurrentValue

      public void setCurrentValue(String value)

    • getCurrentValue

      public String getCurrentValue()

    • setDefaultValue

      public void setDefaultValue(String value)

    • getDefaultValue

      public String getDefaultValue()

    • setAllowedRegExp

      public void setAllowedRegExp(String value)

    • getAllowedRegExp

      public String getAllowedRegExp()
      Overrides:
      getAllowedRegExp in class JDFAbstractState
      Returns:

    • setPresentRegExp

      public void setPresentRegExp(String value)

    • getPresentRegExp

      public String getPresentRegExp()
      Overrides:
      getPresentRegExp in class JDFAbstractState
      Returns:

    • getValue

      public JDFValue getValue(int iSkip)

    • appendValue

      public JDFValue appendValue()

    • getValueLocLoc

      public JDFLoc getValueLocLoc(int iSkip, int jSkip)
      Gets the jSkip'th element Loc of the iSkip'th element Value
      Overrides:
      getValueLocLoc in class JDFAbstractState
      Parameters:
      iSkip - number of Value elements to skip (iSkip=0 -> first Value element)
      jSkip - number of Loc subelements of iSkip'th Value element to skip (jSkip=0 -> first Loc element)
      Returns:
      JDFLoc: the matching Loc element

    • appendValueLocLoc

      public JDFLoc appendValueLocLoc(int iSkip)
      Appends element Loc to the end of the iSkip'th subelement Value
      Overrides:
      appendValueLocLoc in class JDFAbstractState
      Parameters:
      iSkip - number of Value elements to skip (iSkip=0 -> first Value element)
      Returns:
      JDFLoc: newly created Loc element

    • appendValueAllowedValue

      public void appendValueAllowedValue(String value)
      Sets the AllowedValue attribute of the iSkip'th subelement Value
      Parameters:
      value - value to set the attribute to

    • getValueAllowedValue

      public final String getValueAllowedValue(int iSkip)
      Gets the AllowedValue attribute of the iSkip'th subelement Value
      Parameters:
      iSkip - the number of Value elements to skip
      Returns:
      String: the attribute value

    • setValueValueUsage

      public void setValueValueUsage(int iSkip, JDFBaseDataTypes.EnumFitsValue value)
      Sets the ValueUsage attribute of the i-th subelement Value
      Parameters:
      int - iSkip: the number of Value elements to skip
      EnumFitsValue - value: value to set the attribute to

    • getValueValueUsage

      public final JDFBaseDataTypes.EnumFitsValue getValueValueUsage(int iSkip)
      Gets the value of attribute ValueUsage of the iSkip'th subelement Value
      Parameters:
      iSkip - the number of Value elements to skip
      Returns:
      EnumFitsValue: the attribute value

    • addValue

      public void addValue(String value, JDFBaseDataTypes.EnumFitsValue testlists)
      Description copied from class: JDFAbstractState
      add a value to the list of values defined by testlists
      Specified by:
      addValue in class JDFAbstractState
      Parameters:
      value - value to test
      testlists - switches between Allowed test lists and Present test lists. Has two values: Allowed and Present.

    • fitsValue

      public final boolean fitsValue(String value, JDFBaseDataTypes.EnumFitsValue testlists)
      fitsValue - checks whether value matches the Allowed/Present test lists specified for this State
      Specified by:
      fitsValue in class JDFAbstractState
      Parameters:
      value - value to test
      testlists - the test lists the value has to match. In this State the test lists are ValueList AND ValueMod.
      Choose one of two values: FitsValue_Allowed or FitsValue_Present. (Defaults to Allowed)
      Returns:
      boolean - true, if value matches testlists or if AllowedValueList and AllowedValueMod are not specified

    • setAllowedLength

      public void setAllowedLength(JDFIntegerRange value)
      Description copied from class: JDFAbstractState
      set attribute AllowedLength
      Overrides:
      setAllowedLength in class JDFAbstractState
      Parameters:
      value - the value to set the attribute to

    • getAllowedLength

      public JDFIntegerRange getAllowedLength()
      Description copied from class: JDFAbstractState
      get attribute AllowedLength
      Overrides:
      getAllowedLength in class JDFAbstractState
      Returns:
      JDFIntegerRange: the attribute value

    • setPresentLength

      public void setPresentLength(JDFIntegerRange value)
      Overrides:
      setPresentLength in class JDFAbstractState

    • getPresentLength

      public JDFIntegerRange getPresentLength()
      Overrides:
      getPresentLength in class JDFAbstractState

    • getEvaluationType

      public JDFTerm.EnumTerm getEvaluationType()
      Description copied from interface: ICapabilityElement
      get the type of evaluation that is appropriate for this ICapabilityElement
      Specified by:
      getEvaluationType in interface ICapabilityElement
      Specified by:
      getEvaluationType in class JDFAbstractState
      Returns:
      EnumTerm the type of evaluation
      See Also: