Package com.mayam.wf.attributes.shared

Class AttributeRangeMap

java.lang.Object
com.mayam.wf.attributes.shared.AttributeRangeMap
All Implemented Interfaces:
Copyable, Serializable
public class AttributeRangeMap extends Object implements Serializable, Copyable
Map from Attribute to a pair of values representing the start and the end of a range. Optionally, each attribute range may be specified to include null values. When properly injected, the map will validate input to make sure it conforms to Attribute annotations.
Author:
Markus Mårtensson
See Also:

  • Field Details

  • Constructor Details

    • AttributeRangeMap

      public AttributeRangeMap()

  • Method Details

    • injectHelpers

      @Inject public void injectHelpers(AttributeValidator validator, AttributeFieldMapper attributeFieldMapper)
      Injects helper objects. Generally called by injector during creation, later using Injector.injectMembers() or manually by an object having access to both instances. A missing validator will cause the map to silently accept all input whereas
      Parameters:
      validator - AttributeValidator instance.

    • hasInjectedHelpers

      public boolean hasInjectedHelpers()
      Checks for the existence of AttributeValidator helper instance.
      Returns:
      true if the helper is injected.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • setAttributeRange

      public @NonNull AttributeRangeMap setAttributeRange(@NonNull Attribute attribute, @Nullable Object start, @Nullable Object end)
      Sets the range for a given Attribute. Null values are not considered part of the range. Requires a AttributeFieldMapper implementation, which is typically only bound on the server side.
      Parameters:
      attribute - the attribute to set.
      start - the start of the range.
      end - the end of the range.
      Returns:
      the map to allow method chaining.

    • setAttributeRange

      public @NonNull AttributeRangeMap setAttributeRange(@NonNull Attribute attribute, @Nullable Object start, @Nullable Object end, boolean includeNulls)
      Sets the range for a given Attribute.
      Parameters:
      attribute - the attribute to set.
      start - the start of the range.
      end - the end of the range.
      includeNulls - if true, nulls are considered part of the range.
      Returns:
      the map to allow method chaining.

    • setAttributeRangeByFieldId

      public @NonNull AttributeRangeMap setAttributeRangeByFieldId(@NonNull String fieldId, @Nullable Object start, @Nullable Object end)
      Sets the range for a given a field identifier. Null values are not considered part of the range. Requires a AttributeFieldMapper implementation, which is typically only bound on the server side.
      Parameters:
      fieldId - the field identifier.
      start - the start of the range.
      end - the end of the range.
      Returns:
      the map to allow method chaining.

    • setAttributeRangeByFieldId

      public AttributeRangeMap setAttributeRangeByFieldId(@NonNull String fieldId, @Nullable Object start, @Nullable Object end, boolean includeNulls)
      Sets the range for a given a field identifier. Null values are not considered part of the range. Requires a AttributeFieldMapper implementation, which is typically only bound on the server side.
      Parameters:
      fieldId - the field identifier.
      start - the start of the range.
      end - the end of the range.
      includeNulls - if true, nulls are considered part of the range.
      Returns:
      the map to allow method chaining.

    • getAttributeRange

      public @Nullable AttributeRangeMap.Range getAttributeRange(@NonNull Attribute attribute)
      Gets the range for a given Attribute.
      Parameters:
      attribute - the attribute to get.
      Returns:
      the range as a tuple of start and end value.

    • getAttributeRangebyFieldId

      public @Nullable AttributeRangeMap.Range getAttributeRangebyFieldId(@NonNull String fieldId)
      Gets the range for a given field identifier. Requires a AttributeFieldMapper implementation, which is typically only bound on the server side.
      Parameters:
      fieldId - the field identifier.
      Returns:
      the range as a tuple of start and end value.

    • putAll

      public void putAll(@NonNull AttributeRangeMap other)

    • remove

      public void remove(@NonNull Attribute attribute)

    • clear

      public void clear()
      Removes all values from the map.

    • containsAttribute

      public boolean containsAttribute(@NonNull Attribute attribute)

    • getAttributeSet

      public @NonNull Set<Attribute> getAttributeSet()

    • copy

      public AttributeRangeMap copy()
      Creates a full copy of the map.
      Specified by:
      copy in interface Copyable
      Returns:
      new map.

    • copy

      public @NonNull AttributeRangeMap copy(@NonNull Collection<Attribute> attributes)
      Creates a partial copy of the map, including only the provided collection of attributes.
      Returns:
      new map.

    • getStartManager

      public @NonNull AttributeManager getStartManager()
      Returns an AttributeManager which manages only the start values of this map.

    • getEndManager

      public @NonNull AttributeManager getEndManager()
      Returns an AttributeManager which manages only the end values of this map.

    • merge

      public static @Nullable AttributeRangeMap merge(@Nullable AttributeRangeMap original, @Nullable AttributeRangeMap overrides)
      Merges two AttributeRangeMap objects with priority given to the one referred to as "overrides". Expected to be called as "original = merge(original,overrides)". For this reason, original may become updated whereas overrides will not be touched.
      Parameters:
      original - original map, or null.
      overrides - map with overrides, or null.
      Returns:
      merged map, or null if both arguments were null.