Package wt.series

Class MulticharacterSeries

java.lang.Object
wt.series._Series
wt.series.Series
wt.series._MulticharacterSeries
wt.series.MulticharacterSeries
All Implemented Interfaces:
Externalizable, Serializable, Cloneable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable
@GenAsObjectMappable(superClass=Series.class, extendable=true, versions=7620537180150616532L, properties=@GeneratedProperty(name="seriesName",type=java.lang.String.class,accessors=@PropertyAccessors(setAccess=PRIVATE),columnProperties=@ColumnProperties(persistent=false))) public class MulticharacterSeries extends wt.series._MulticharacterSeries
Defines a sequencing model of multicharacter values from one character up to a span of characters of length, where each single character ranges from min to max with an increment of delta between each adjacent value.

For example, this series could be a length of 3, with a min of A and a max of Z, and a delta of 1. With this the initial value would be A. The max value with the length would be ZZZ. When the series reached a value of Z and was incremented it would then be BA. When the series reached a value of AA and was decremented it would then be Z.

Use the newMulticharacterSeries static factory method(s), not the MulticharacterSeries constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: true

See Also:

  • Method Details

    • getMin

      public static Character getMin()
      Gets the value of the attribute: MIN. The minimum limit of a character within the series.

      Supported API: true
      Returns:
      Character

    • setMin

      protected static void setMin(Character a_Min) throws WTPropertyVetoException
      Sets the value of the attribute: MIN. The minimum limit of a character within the series.

      Supported API: true
      Parameters:
      a_Min -
      Throws:
      WTPropertyVetoException

    • getMax

      public static Character getMax()
      Gets the value of the attribute: MAX. The maximum limit of a character within the series.

      Supported API: true
      Returns:
      Character

    • setMax

      protected static void setMax(Character a_Max) throws WTPropertyVetoException
      Sets the value of the attribute: MAX. The maximum limit of a character within the series.

      Supported API: true
      Parameters:
      a_Max -
      Throws:
      WTPropertyVetoException

    • getDelta

      protected static Integer getDelta()
      Gets the value of the attribute: DELTA. The increment between adjacent characters within the series.

      Supported API: true
      Returns:
      Integer

    • setDelta

      protected static void setDelta(Integer a_Delta) throws WTPropertyVetoException
      Sets the value of the attribute: DELTA. The increment between adjacent characters within the series.

      Supported API: true
      Parameters:
      a_Delta -
      Throws:
      WTPropertyVetoException

    • getLength

      protected static Integer getLength()
      Gets the value of the attribute: LENGTH. The total length in characters that the series can grow.

      Supported API: true
      Returns:
      Integer

    • setLength

      protected static void setLength(Integer a_Length) throws WTPropertyVetoException
      Sets the value of the attribute: LENGTH. The total length in characters that the series can grow.

      Supported API: true
      Parameters:
      a_Length -
      Throws:
      WTPropertyVetoException

    • newMulticharacterSeries

      public static MulticharacterSeries newMulticharacterSeries() throws WTPropertyVetoException
      Makes a new instance.

      Supported API: true
      Returns:
      MulticharacterSeries
      Throws:
      WTPropertyVetoException

    • newMulticharacterSeries

      public static MulticharacterSeries newMulticharacterSeries(String value) throws WTPropertyVetoException
      Makes a new instance where the value is set to the given string.

      Supported API: true
      Parameters:
      value -
      Returns:
      MulticharacterSeries
      Throws:
      WTPropertyVetoException

    • initialize

      protected void initialize(String value) throws WTPropertyVetoException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Parameters:
      value -
      Throws:
      WTPropertyVetoException

    • newMulticharacterSeries

      public static MulticharacterSeries newMulticharacterSeries(String seriesName, String value) throws WTPropertyVetoException
      Makes a new instance where the value is set to the given string.

      Supported API: true
      Parameters:
      seriesName -
      value -
      Returns:
      MulticharacterSeries
      Throws:
      WTPropertyVetoException

    • initialize

      protected void initialize(String seriesName, String value) throws WTPropertyVetoException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Parameters:
      seriesName -
      value -
      Throws:
      WTPropertyVetoException

    • reset

      public void reset() throws SeriesException, WTPropertyVetoException
      Resets the value of the series to its min.

      Supported API: true
      Specified by:
      reset in class Series
      Throws:
      SeriesException
      WTPropertyVetoException

    • increment

      public void increment() throws SeriesException, WTPropertyVetoException
      Increments the value of the series to the next adjacent value.

      Supported API: true
      Specified by:
      increment in class Series
      Throws:
      SeriesException
      WTPropertyVetoException

    • decrement

      public void decrement() throws SeriesException, WTPropertyVetoException
      Decrements the value of the series to the next adjacent value.

      Supported API: true
      Specified by:
      decrement in class Series
      Throws:
      SeriesException
      WTPropertyVetoException

    • equals

      public boolean equals(Series object)
      Tests if the value of this series is equal to the given one and returns true. Otherwise, returns false.

      Supported API: true
      Specified by:
      equals in class Series
      Parameters:
      object -
      Returns:
      boolean

    • lessThan

      public boolean lessThan(Series object)
      Tests if the value of this series is less than to the given one and returns true. Otherwise, returns false.

      Supported API: true
      Specified by:
      lessThan in class Series
      Parameters:
      object -
      Returns:
      boolean

    • greaterThan

      public boolean greaterThan(Series object)
      Tests if the value of this series is greater than to the given one and returns true. Otherwise, returns false.

      Supported API: true
      Specified by:
      greaterThan in class Series
      Parameters:
      object -
      Returns:
      boolean

    • getValue

      public String getValue()
      Overrides super class' getter to specifically deal with an integer value stored as a string.

      Supported API: true
      Overrides:
      getValue in class _Series
      Returns:
      String
      See Also:

    • setValue

      protected void setValue(String aValue) throws WTPropertyVetoException
      Overrides super class' setter to specifically deal with an integer value stored as a string.

      Supported API: true
      Overrides:
      setValue in class _Series
      Parameters:
      aValue -
      Throws:
      WTPropertyVetoException
      See Also:

    • currCharAt

      protected Character currCharAt(int pos)
      Determines the current character in the series.

      Supported API: true
      Parameters:
      pos -
      Returns:
      Character

    • incrementedCharAt

      protected Character incrementedCharAt(int pos)
      Determines the next incremented character of the character at the given position in the series.

      Supported API: true
      Parameters:
      pos -
      Returns:
      Character

    • decrementedCharAt

      protected Character decrementedCharAt(int pos)
      Determines the next decremented character of the character at the position in the series.

      Supported API: true
      Parameters:
      pos -
      Returns:
      Character

    • initialize

      protected void initialize() throws WTPropertyVetoException


      Supported API: true
      Throws:
      WTPropertyVetoException