Package step.core.accessors

Interface Accessor<T extends step.core.accessors.AbstractIdentifiableObject>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      T findByAttributes​(java.util.Map<java.lang.String,​java.lang.String> attributes)
      Find an object by default attributes.
      T findByAttributes​(java.util.Map<java.lang.String,​java.lang.String> attributes, java.lang.String attributesMapKey)
      Find an object by attributes.
      java.util.Spliterator<T> findManyByAttributes​(java.util.Map<java.lang.String,​java.lang.String> attributes)
      Find objects by attributes.
      java.util.Spliterator<T> findManyByAttributes​(java.util.Map<java.lang.String,​java.lang.String> attributes, java.lang.String attributesMapKey)
      Find objects by attributes.
      T get​(java.lang.String id)
      Get an object by id
      T get​(org.bson.types.ObjectId id)
      Get an object by id
      java.util.Iterator<T> getAll()  
      java.util.List<T> getRange​(int skip, int limit)
      Get the range of objects specified by the skip/limit parameters browsing the collection sorted by ID in the descending order

    • Method Detail

      • get

        T get​(org.bson.types.ObjectId id)
        Get an object by id
        Parameters:
        id - the UID of the object
        Returns:
        the object

      • get

        T get​(java.lang.String id)
        Get an object by id
        Parameters:
        id - the UID of the object
        Returns:
        the object

      • findByAttributes

        T findByAttributes​(java.util.Map<java.lang.String,​java.lang.String> attributes)
        Find an object by default attributes. If multiple objects match these attributes, the first one will be returned
        Parameters:
        attributes - the map of mandatory attributes of the object to be found
        Returns:
        the object

      • findManyByAttributes

        java.util.Spliterator<T> findManyByAttributes​(java.util.Map<java.lang.String,​java.lang.String> attributes)
        Find objects by attributes.
        Parameters:
        attributes - the map of mandatory attributes of the object to be found
        Returns:
        an Iterator for the objects found

      • getAll

        java.util.Iterator<T> getAll()

      • findByAttributes

        T findByAttributes​(java.util.Map<java.lang.String,​java.lang.String> attributes,
                   java.lang.String attributesMapKey)
        Find an object by attributes. If multiple objects match these attributes, the first one will be returned
        Parameters:
        attributes - the map of mandatory attributes of the object to be found
        attributesMapKey - the string representing the name (or "key") of the attribute map
        Returns:
        the object

      • findManyByAttributes

        java.util.Spliterator<T> findManyByAttributes​(java.util.Map<java.lang.String,​java.lang.String> attributes,
                                              java.lang.String attributesMapKey)
        Find objects by attributes.
        Parameters:
        attributes - the map of mandatory attributes of the object to be found
        attributesMapKey - the string representing the name (or "key") of the attribute map
        Returns:
        an Iterator for the objects found

      • getRange

        java.util.List<T> getRange​(int skip,
                           int limit)
        Get the range of objects specified by the skip/limit parameters browsing the collection sorted by ID in the descending order
        Parameters:
        skip - the start index (inclusive) of the range
        limit - the size of the range
        Returns:
        a List containing the objects of the specified range