Package me.ahoo.cosid.converter

Class GroupedPrefixIdConverter

java.lang.Object
me.ahoo.cosid.converter.GroupedPrefixIdConverter
All Implemented Interfaces:
Decorator<IdConverter>, IdConverter, Statistical
public class GroupedPrefixIdConverter extends Object implements IdConverter, Decorator<IdConverter>
Converter that prepends a dynamic group key as prefix to string IDs.

The group key comes with the id: asString(long, GroupedKey), as called by SegmentId.generateGroupedAsString() and the string segment generators.

  • Field Details

    • DEFAULT_DELIMITER

      public static final String DEFAULT_DELIMITER
      Default delimiter between group key and ID.
      See Also:

  • Constructor Details

    • GroupedPrefixIdConverter

      public GroupedPrefixIdConverter(String delimiter, IdConverter actual)
      Creates a grouped prefix converter.
      Parameters:
      delimiter - the delimiter between group key and ID
      actual - the underlying converter

  • Method Details

    • 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

    • getDelimiter

      public String getDelimiter()
      Gets the delimiter.
      Returns:
      the delimiter

    • asString

      public @NonNull String asString(long id)
      Not supported: the group is not known from the id alone.
      Specified by:
      asString in interface IdConverter
      Parameters:
      id - The long type ID to convert
      Returns:
      The String representation of the ID
      Throws:
      UnsupportedOperationException - always; use asString(long, GroupedKey)

    • asString

      public @NonNull String asString(long id, @NonNull GroupedKey group)
      Prefix the id with the key of group.
      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

    • 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