Package hec.rss.model.globalvariable

Class StringGlobalVariable

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.rss.model.globalvariable.BaseGlobalVariable
hec.rss.model.globalvariable.StringGlobalVariable
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, GlobalVariable, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable
public class StringGlobalVariable extends BaseGlobalVariable implements GlobalVariable
See Also:

  • Field Details

  • Constructor Details

    • StringGlobalVariable

      public StringGlobalVariable()

    • StringGlobalVariable

      public StringGlobalVariable(RssSystem network)

  • Method Details

    • clone

      public StringGlobalVariable clone()
      Description copied from class: NamedType
      Creates a new object of the same class as this object.
      It then initializes each of the new object's fields by assigning it the same value as the corresponding field in this object. No
      constructor is called.
      Specified by:
      clone in interface GlobalVariable
      Overrides:
      clone in class BaseGlobalVariable

    • getCharacterSetType

      public CharacterSetType getCharacterSetType()

    • setCharacterSetType

      public void setCharacterSetType(CharacterSetType characterSetType)

    • getType

      public GlobalVariableType getType()
      Specified by:
      getType in interface GlobalVariable

    • getValue

      public String getValue()
      get the value of the String Global Variable
      Returns:
      the String Global Variable's value

    • setValue

      public void setValue(String value)
      set the value of the Output String Global Variable
      Parameters:
      value - the new value

    • isFreeform

      public boolean isFreeform()

    • setFreeForm

      public void setFreeForm(boolean isFreeForm)

    • isCaseSensitive

      public boolean isCaseSensitive()

    • setCaseSensitive

      public void setCaseSensitive(boolean isCaseSensitive)

    • getInvalidCharacters

      public List<Character> getInvalidCharacters()

    • setInvalidCharacters

      public void setInvalidCharacters(List<Character> invalidCharacters)

    • getSelectionList

      public List<String> getSelectionList()
      get the List of Strings in the Selection List.
      Returns:
      the Selection List
      See Also:

    • getSelectionListIndex

      public int getSelectionListIndex()
      Returns:
      -1 selection not found in list -2 not using selection list >0 index in list

    • getSelectListLength

      public int getSelectListLength()
      Returns:

    • appendToSelectionList

      public void appendToSelectionList(String newStr)
      append a non-null unique String to the selection list
      Parameters:
      newStr - the String to add to the end of the selection list
      See Also:

    • isSelection

      public boolean isSelection()
      does the String Global Variable use a selection List
      Returns:
      true if the String Global Variable is using a selection list
      See Also:

    • setSelectionList

      public void setSelectionList(List<String> selectionList)
      set the new List of selections for the String Global Variable
      Parameters:
      selectionList - the new Selection List
      See Also:

    • getDescriptiveText

      public String getDescriptiveText()
      Description copied from interface: GlobalVariable
      gets a description of the type of the global variable
      Specified by:
      getDescriptiveText in interface GlobalVariable
      Returns:
      descriptive text

    • hasValidValue

      public String hasValidValue()
      check to see if the ScalarGlobalVariable has a valid value
      Specified by:
      hasValidValue in interface GlobalVariable
      Overrides:
      hasValidValue in class BaseGlobalVariable
      Returns:
      null if the value is valid or the ScalarGlobalVariable has no value

    • outputReport

      public void outputReport(AlternativeInputReport report, org.jdom.Element myElem)
      called when created the network part of the alternative report
      Specified by:
      outputReport in interface GlobalVariable
      Overrides:
      outputReport in class BaseGlobalVariable
      Parameters:
      report - the alternative report
      myElem - the element for this global variable

    • getFieldObject

      public Object getFieldObject(Field fld)
      Description copied from interface: FieldAccessor
      This method allows access to java.lang.reflect.Field objects within the implementing class.
      Specified by:
      getFieldObject in interface FieldAccessor
      Overrides:
      getFieldObject in class BaseGlobalVariable
      Parameters:
      fld - The field to get.
      Returns:
      The data object that is stored in the given field

    • setFieldObject

      public boolean setFieldObject(Field fld, Object fobj)
      Description copied from interface: FieldAccessor
      This allows access to fields withing the implementing object to set there data.
      Specified by:
      setFieldObject in interface FieldAccessor
      Overrides:
      setFieldObject in class BaseGlobalVariable
      Parameters:
      fld - The java field object representing the member field to be set
      fobj - The data to set in that field
      Returns:
      returns true if successful

    • isFilePath

      public boolean isFilePath()
      is this String Global Variable a file path.
      Returns:

    • setFilePath

      public void setFilePath(boolean filePath)
      set if this String Global Variable is a file path.
      Parameters:
      filePath -