Module datarush.library
Package com.pervasive.datarush.sequences.scalar

Class DateTokenList

java.lang.Object
com.pervasive.datarush.sequences.scalar.AbstractScalarTokenSequence
com.pervasive.datarush.sequences.scalar.DateTokenList
All Implemented Interfaces:
MutableTokenSequence, DateTokenSequence, MutableDateTokenSequence, MutableScalarTokenSequence, ScalarTokenAppendable, ScalarTokenSequence, TokenAppendable, TokenSequence, ScalarTyped, TokenTyped
public final class DateTokenList extends AbstractScalarTokenSequence implements MutableDateTokenSequence
Primary implementation of MutableDateTokenSequence.
See Also:

  • Constructor Details

    • DateTokenList

      public DateTokenList(int initialCapacity)
      Create an empty array
      Parameters:
      initialCapacity - the initial capacity.

  • Method Details

    • getType

      public ScalarTokenType getType()
      Description copied from interface: ScalarTokenSequence
      Gets the data type of the tokens in the sequence.
      Specified by:
      getType in interface ScalarTokenSequence
      Specified by:
      getType in interface ScalarTyped
      Specified by:
      getType in interface TokenTyped
      Returns:
      the token data type

    • getDate

      public Date getDate(int index)
      Description copied from interface: DateTokenSequence
      Gets the value of the specified token as a date.
      Specified by:
      getDate in interface DateTokenSequence
      Parameters:
      index - the position of the token in the sequence
      Returns:
      the value of the token. If the token is null valued, null is returned.

    • getDate

      public Date getDate(int index, ZoneId zoneId)
      Description copied from interface: DateTokenSequence
      Gets the value of the specified token as a date interpreted in the given timezone.
      Specified by:
      getDate in interface DateTokenSequence
      Parameters:
      index - the index of the token
      zoneId - the timezone id relative to which to interpret the date.
      Returns:
      the value of the token. If the token is null valued, null is returned.

    • getEpochDays

      public long getEpochDays(int index)
      Description copied from interface: DateTokenSequence
      Get the value of the specified token as the number of days elapsed since January 1, 1970 00:00:00 GMT.
      Specified by:
      getEpochDays in interface DateTokenSequence
      Parameters:
      index - the index of the token
      Returns:
      the value of the element. If the token is null valued, 0 is returned.

    • getCalendarDate

      public CalendarDate getCalendarDate(int index)
      Description copied from interface: DateTokenSequence
      Gets the value of the specified token as a calendar date.
      Specified by:
      getCalendarDate in interface DateTokenSequence
      Parameters:
      index - the position of the token in the sequence
      Returns:
      the value of the token. If the token is null valued, null is returned.

    • getToken

      public DateValued getToken(int index)
      Description copied from interface: TokenSequence
      Gets the value at the specified position.
      Specified by:
      getToken in interface DateTokenSequence
      Specified by:
      getToken in interface ScalarTokenSequence
      Specified by:
      getToken in interface TokenSequence
      Parameters:
      index - the index of the token
      Returns:
      the value

    • getTokenSetter

      public DateSettable getTokenSetter(int index)
      Description copied from interface: MutableTokenSequence
      Returns a mutator for the given index.
      Specified by:
      getTokenSetter in interface MutableDateTokenSequence
      Specified by:
      getTokenSetter in interface MutableScalarTokenSequence
      Specified by:
      getTokenSetter in interface MutableTokenSequence
      Parameters:
      index - the position
      Returns:
      a mutator for the given index.

    • getValues

      public void getValues(int index, long[] values, boolean[] nullFlags, int offset, int length)
      Description copied from interface: DateTokenSequence
      Gets the values and null indicators for a range of tokens.
      Specified by:
      getValues in interface DateTokenSequence
      Parameters:
      index - the starting index of the range
      values - an array into which to place element values, represented as epoch days
      nullFlags - an array into which to place null indicator values
      offset - the starting offset into the target arrays. That is, elements[offset] and nulls[offset] will get the value and null indicator respectively of the token at position start, and so on.
      length - number of tokens to get
      See Also:

    • setNull

      public void setNull(int index)
      Description copied from interface: MutableTokenSequence
      Sets the token at the specified position to be null valued.
      Specified by:
      setNull in interface MutableTokenSequence
      Parameters:
      index - the position of the token in the array

    • setNull

      public void setNull(int start, int length)
      Description copied from interface: MutableTokenSequence
      Sets the tokens in the specified subsequence to be null valued.
      Specified by:
      setNull in interface MutableTokenSequence
      Parameters:
      start - the starting index of the subsequence in the array
      length - the length of the subsequence

    • setZero

      public void setZero(int index)
      Description copied from interface: MutableTokenSequence
      Sets the token at the specified position to be zero valued.
      Specified by:
      setZero in interface MutableTokenSequence
      Parameters:
      index - the position of the token in the array

    • setZero

      public void setZero(int start, int length)
      Description copied from interface: MutableTokenSequence
      Sets the tokens in the specified subsequence to be zero valued.
      Specified by:
      setZero in interface MutableTokenSequence
      Parameters:
      start - the starting index of the subsequence in the array
      length - the length of the subsequence

    • isZero

      public final boolean isZero(int index)
      Description copied from interface: ScalarTokenSequence
      Indicates whether the specified token has a zero value.
      Specified by:
      isZero in interface ScalarTokenSequence
      Parameters:
      index - the index of the token
      Returns:
      true if the element is zero, false otherwise

    • setDate

      public void setDate(int index, Date value)
      Sets the token at the specified position to a date value specified as a java.util.Date object, relative to the default time zone. The time zone returned by TimeZone.getDefault() is used.
      Parameters:
      index - the position of the token in the array
      value - the date value to which to set the token, expressed as a point in time relative to the default time zone. Passing null is equivalent to calling setNull(index}.

    • fillDate

      public void fillDate(int start, int length, Date value)
      Sets the tokens in the specified subsequence to a date value specified as a java.util.Date object, relative to the default time zone.
      Parameters:
      start - the starting index of the subsequence in the array
      length - the length of the subsequence
      value - the date value to which to set the tokens, expressed as a point in time relative to the default time zone. Passing null is equivalent to calling setNull(start, length}.

    • setDate

      public void setDate(int index, Date value, ZoneId zoneId)
      Sets the token at the specified position to a date value specified as a java.util.Date object, relative to the given time zone. The time zone returned by TimeZone.getDefault() is used.
      Parameters:
      index - the position of the token in the array
      value - the date value to which to set the token, expressed as a point in time relative to the specified time zone. Passing null is equivalent to calling setNull(index}.
      zoneId - the time zone id in which the date should be interpreted

    • fillDate

      public void fillDate(int start, int length, Date value, ZoneId zoneId)
      Sets the tokens in the specified subsequence to a date value specified as a java.util.Date object, relative to the given time zone.
      Parameters:
      start - the starting index of the subsequence in the array
      length - the length of the subsequence
      value - the date value to which to set the tokens, expressed as a point in time relative to the specified time zone. Passing null is equivalent to calling setNull(start, length}.
      zoneId - the time zone id in which the date should be interpreted

    • setEpochDays

      public void setEpochDays(int index, long days)
      Sets the token at the specified position to a date value specified as the number of days since Java epoch (January 1, 1970 GMT).
      Specified by:
      setEpochDays in interface MutableDateTokenSequence
      Parameters:
      days - date value to which to set the token, expressed as the number of days since Java epoch
      index - the position to modify

    • fillEpochDays

      public void fillEpochDays(int start, int length, long days)
      Sets the tokens in the specified subsequence to a date value specified as the number of days since Java epoch (January 1, 1970 GMT).
      Parameters:
      start - the starting index of the subsequence in the array
      length - the length of the subsequence
      days - date value to which to set the token, expressed as the number of days since Java epoch

    • setCalendarDate

      public void setCalendarDate(int index, CalendarDate value)
      Sets the token at the specified position to the specified calendar date.
      Parameters:
      index - the position of the token in the array
      value - the calendar date to which to set the token. Passing null is equivalent to calling setNull(index}.

    • fillCalendarDate

      public void fillCalendarDate(int start, int length, CalendarDate value)
      Sets the tokens in the specified subsequence to the specified calendar date.
      Parameters:
      start - the starting index of the subsequence in the array
      length - the length of the subsequence
      value - the calendar date to which to set the tokens. Passing null is equivalent to calling setNull(start, length}.

    • setValue

      public void setValue(int index, TokenValued value)
      Description copied from interface: MutableTokenSequence
      Sets the token at the specified position to the given value.
      Specified by:
      setValue in interface MutableTokenSequence
      Parameters:
      index - the position of the token in the array
      value - the value to which to set the token. This value must be of an appropriate type for the array.

    • fillValue

      public void fillValue(int start, int length, TokenValued value)
      Description copied from interface: MutableTokenSequence
      Sets the tokens in the specified subsequence to the given value.
      Specified by:
      fillValue in interface MutableTokenSequence
      Parameters:
      start - the starting index of the subsequence in the array
      length - the length of the subsequence
      value - the value to which to set the tokens. This value must be of an appropriate type for the array

    • setValues

      public void setValues(int start, TokenSequence values, int offset, int length)
      Description copied from interface: MutableTokenSequence
      Sets the tokens in the specified subsequence of the array to the corresponding values from a subsequence of the given source sequence.
      Specified by:
      setValues in interface MutableTokenSequence
      Parameters:
      start - the starting index of the subsequence in the array
      values - the source sequence. This sequence must be of an appropriate type for the array.
      offset - the starting index in the source sequence. Corresponding values will be taken relative to this position. That is, the value of the token at position offset in values will be assigned to the token at position start, and so on.
      length - the number of tokens to copy

    • append

      public void append(Date value)
      Description copied from interface: MutableDateTokenSequence
      Appends the specified date to this sequence.
      Specified by:
      append in interface MutableDateTokenSequence
      Parameters:
      value - the value to append.

    • append

      public void append(Date value, int count)
      Description copied from interface: MutableDateTokenSequence
      Appends the specified date to this sequence.
      Specified by:
      append in interface MutableDateTokenSequence
      Parameters:
      value - the value to append.
      count - the number of copies to append.

    • appendEpochDays

      public void appendEpochDays(long epochDays)
      Description copied from interface: MutableDateTokenSequence
      Appends the date specified as days elapsed since January 1, 1970 00:00:00 GMT to this sequence.
      Specified by:
      appendEpochDays in interface MutableDateTokenSequence
      Parameters:
      epochDays - the value to append.

    • appendEpochDays

      public void appendEpochDays(long epochDays, int count)
      Description copied from interface: MutableDateTokenSequence
      Appends the date specified as days elapsed since January 1, 1970 00:00:00 GMT to this sequence multiple times.
      Specified by:
      appendEpochDays in interface MutableDateTokenSequence
      Parameters:
      epochDays - the value to append.
      count - the number of copies to append.

    • append

      public void append(CalendarDate value)
      Description copied from interface: MutableDateTokenSequence
      Appends the specified calendar date to this sequence.
      Specified by:
      append in interface MutableDateTokenSequence
      Parameters:
      value - the value to append.

    • append

      public void append(CalendarDate value, int count)
      Description copied from interface: MutableDateTokenSequence
      Appends the specified calendar date to this sequence.
      Specified by:
      append in interface MutableDateTokenSequence
      Parameters:
      value - the value to append.
      count - the number of copies to append.

    • newValueIterator

      public DateValuedIterator newValueIterator()
      Description copied from interface: TokenSequence
      Creates an iterator over the non-null values of this sequence. The iterator will automatically be reset as modifications are made to the sequence.
      Specified by:
      newValueIterator in interface DateTokenSequence
      Specified by:
      newValueIterator in interface ScalarTokenSequence
      Specified by:
      newValueIterator in interface TokenSequence
      Returns:
      an newly-created iterator over the non-null values of this sequence.