Interface FeatureKey

All Superinterfaces:
Comparable<FeatureKey>, Serializable
All Known Implementing Classes:
SegmentFeatureKey

public interface FeatureKey extends Serializable, Comparable<FeatureKey>
Feature key is universal segmented path identifies the feature in child objects. All clients must use default implementation SegmentFeatureKey.
See Also:
  • Method Details

    • getId

      String getId()
      Gets the id representing default serializing of the object to string.
      Returns:
      the id
    • getSegments

      List<String> getSegments()
      Gets the segments.
      Returns:
      the segments
    • isEmpty

      boolean isEmpty()
      Checks if the key is empty, means that segments are empty.
      Returns:
      true, if is empty
    • getSegmentCount

      int getSegmentCount()
      Gets the segment count.
      Returns:
      the segment count
    • getSegment

      String getSegment(int index)
      Gets the segment.
      Parameters:
      index - the index
      Returns:
      the segment
    • getLastSegment

      String getLastSegment()
      Gets the last segment.
      Returns:
      the last segment
    • getFirstSegment

      String getFirstSegment()
      Gets the first segment.
      Returns:
      the first segment
    • append

      FeatureKey append(String segment)
      Append.
      Parameters:
      segment - the segment
      Returns:
      the new feature key
    • append

      FeatureKey append(FeatureKey relativeFeatureKey)
      Append.
      Parameters:
      relativeFeatureKey - the relative feature key
      Returns:
      the new feature key
    • skipFirst

      FeatureKey skipFirst(int skipCount)
      Skip first.
      Parameters:
      skipCount - the skip count
      Returns:
      the new feature key
    • skipLast

      FeatureKey skipLast(int skipCount)
      Skip last segments
      Parameters:
      skipCount - the skip count
      Returns:
      the new feature key
    • startsWith

      boolean startsWith(FeatureKey prefix)
      Starts with.
      Parameters:
      prefix - the prefix
      Returns:
      true, if successful
    • startsWithIgnoreCase

      boolean startsWithIgnoreCase(FeatureKey prefix)
      Starts with ignore case.
      Parameters:
      prefix - the prefix
      Returns:
      true, if successful
    • toLowerCase

      FeatureKey toLowerCase()
      To lower case.
      Returns:
      the new feature key
    • toUpperCase

      FeatureKey toUpperCase()
      To upper case.
      Returns:
      the new feature key
    • compareToIgnoreCase

      int compareToIgnoreCase(FeatureKey key)
      Compare to FeatureKey with ignore case of segments.
      Parameters:
      key - the key to compare
      Returns:
      the result