Package wt.series

Class Series

java.lang.Object
wt.series._Series
wt.series.Series
All Implemented Interfaces:
Externalizable, Serializable, Cloneable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable
Direct Known Subclasses:
wt.series._FileBasedSeries, wt.series._IntegerSeries, wt.series._MulticharacterSeries, _MultilevelSeries
@GenAsObjectMappable(interfaces=java.lang.Cloneable.class, extendable=true, versions=-4274618656431536883L, properties=@GeneratedProperty(name="value",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="The current value of an increment in the series.",accessors=@PropertyAccessors(setAccess=PROTECTED),constraints=@PropertyConstraints(upperLimit=60))) public abstract class Series extends _Series
Specifies an abstract model of items in a predefined sequence. This model has a value, ways to iterate through the sequence, and comparison tests between two values of the same sequence.

The idea is to subclass this abstract class to define a particular kind of series. For example, a simple specialized series would be whole integer numbers where there would be a predefined minimum value, maximum value, and an increment or safe delta between to adjacent numbers.



Supported API: true

Extendable: true
See Also:

  • Field Summary

    Fields inherited from class wt.series._Series

    VALUE

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    decrement()
    Specifies an abstract means of decrementing the value to the next adjacent descending value in a series.
    abstract boolean
    equals(Series object)
    Tests if this series is equal to the given one and returns true.
    String
    getUniqueSeriesName()
    Returns a unique string to represent this class.
    abstract boolean
    greaterThan(Series object)
    Tests if this series is greater than to the given one and returns true.
    abstract void
    increment()
    Specifies an abstract means of incrementing the value to the next adjacent ascending value in a series.
    abstract boolean
    lessThan(Series object)
    Tests if this series is less than to the given one and returns true.
    static final Series
    newSeries(String userClassName)
    Makes a new instance of one of the subclassed series as defined in a property where the using class is paired with the series subclass.
    static final Series
    newSeries(String userClassName, String value)
    Makes a new instance of one of the subclassed series as defined in a property where the using class is paired with the series subclass.
    abstract void
    reset()
    Specifies an abstract means of resetting the value to the first one in a series.

    Methods inherited from class wt.series._Series

    getValue, setValue

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • newSeries

      public static final Series newSeries(String userClassName) throws SeriesException
      Makes a new instance of one of the subclassed series as defined in a property where the using class is paired with the series subclass.

      Supported API: true
      Parameters:
      userClassName -
      Returns:
      Series
      Throws:
      SeriesException

    • newSeries

      public static final Series newSeries(String userClassName, String value) throws SeriesException
      Makes a new instance of one of the subclassed series as defined in a property where the using class is paired with the series subclass. Plus, the initial value of this new instance is set to the given value.

      Supported API: true
      Parameters:
      userClassName -
      value -
      Returns:
      Series
      Throws:
      SeriesException

    • reset

      public abstract void reset() throws SeriesException, WTPropertyVetoException
      Specifies an abstract means of resetting the value to the first one in a series.

      Supported API: true
      Throws:
      SeriesException
      WTPropertyVetoException

    • increment

      public abstract void increment() throws SeriesException, WTPropertyVetoException
      Specifies an abstract means of incrementing the value to the next adjacent ascending value in a series.

      Supported API: true
      Throws:
      SeriesException
      WTPropertyVetoException

    • decrement

      public abstract void decrement() throws SeriesException, WTPropertyVetoException
      Specifies an abstract means of decrementing the value to the next adjacent descending value in a series.

      Supported API: true
      Throws:
      SeriesException
      WTPropertyVetoException

    • equals

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

      Supported API: true
      Parameters:
      object -
      Returns:
      boolean

    • lessThan

      public abstract boolean lessThan(Series object)
      Tests if this series is less than to the given one and returns true. Otherwise, returns false. This API assumes that both series are valid for comparison. It is calling application's responsibility to exclude series associated with Change Version from being compared using this API. Otherwise unexpected results might be observed.

      Supported API: true
      Parameters:
      object -
      Returns:
      boolean

    • greaterThan

      public abstract boolean greaterThan(Series object)
      Tests if this series is greater than to the given one and returns true. Otherwise, returns false. This API assumes that both series are valid for comparison. It is calling application's responsibility to exclude series associated with Change Version from being compared using this API. Otherwise unexpected results might be observed.

      Supported API: true
      Parameters:
      object -
      Returns:
      boolean

    • getUniqueSeriesName

      public String getUniqueSeriesName()
      Returns a unique string to represent this class. Typically the name of the class.

      Supported API: true
      Returns:
      String