Package me.ahoo.cosid.converter

Class DatePrefixIdConverter

java.lang.Object
me.ahoo.cosid.converter.DatePrefixIdConverter
All Implemented Interfaces:
Decorator<IdConverter>, IdConverter, Statistical
public class DatePrefixIdConverter extends Object implements IdConverter, Decorator<IdConverter>
ID converter that prepends a date prefix to the ID string.

This converter wraps another IdConverter and adds a date-based prefix, useful for time-based partitioning or bucketing of IDs.

  • Constructor Details

    • DatePrefixIdConverter

      public DatePrefixIdConverter(String pattern, String delimiter, IdConverter actual)
      Creates a new DatePrefixIdConverter.
      Parameters:
      pattern - date format pattern (see DateTimeFormatter)
      delimiter - delimiter between prefix and ID
      actual - the underlying converter to wrap

  • Method Details

    • asString

      public @NonNull String asString(long id)
      Description copied from interface: IdConverter
      Convert a long type ID to its String representation.

      This method transforms a numeric ID into a string format according to the specific conversion algorithm implemented by the converter. For example, a radix converter might convert the number 12345 to "3d7".

      Specified by:
      asString in interface IdConverter
      Parameters:
      id - The long type ID to convert
      Returns:
      The String representation of the ID

    • asString

      public @NonNull String asString(long id, @NonNull GroupedKey group)
      Description copied from interface: IdConverter
      Convert an id from a segment of group to its String representation.

      Converters that do not depend on the group ignore it, which is the default; decorators pass it on to the converter they wrap. A group-aware converter such as GroupedPrefixIdConverter only works through this method.

      A custom decorator that does not override this method falls back to IdConverter.asString(long) of the converter it wraps and loses the group: override it and pass group on.

      Specified by:
      asString in interface IdConverter
      Parameters:
      id - the id
      group - the group of the segment the id came from, GroupedKey.NEVER when it is not grouped
      Returns:
      the String representation of the id

    • asLong

      public long asLong(@NonNull String idString)
      Description copied from interface: IdConverter
      Convert a String type ID back to its long representation.

      This method performs the reverse operation of IdConverter.asString(long), transforming a string ID back into its original numeric form. Implementations should be able to correctly parse strings generated by their IdConverter.asString(long) method.

      Specified by:
      asLong in interface IdConverter
      Parameters:
      idString - The String type ID to convert
      Returns:
      The long representation of the ID

    • getActual

      public @NonNull IdConverter getActual()
      Description copied from interface: Decorator
      Get the actual (wrapped) object that this decorator is enhancing.

      This method returns the underlying object that this decorator is wrapping. For ID generators, this would typically be the base generator that is being enhanced with additional functionality.

      Specified by:
      getActual in interface Decorator<IdConverter>
      Returns:
      The actual object being decorated

    • stat

      public Stat stat()
      Description copied from interface: IdConverter
      Get statistical information about this converter.

      This method provides basic statistical information about the converter, including its implementation class name.

      Specified by:
      stat in interface IdConverter
      Specified by:
      stat in interface Statistical
      Returns:
      Statistical information about this converter