Package step.core.accessors

Interface Accessor<T extends AbstractIdentifiableObject>

All Known Subinterfaces:

CRUDAccessor<T>, ExecutionAccessor, ExecutionTaskAccessor, FunctionAccessor, ParameterAccessor, PlanAccessor, ReportNodeAccessor, ResourceAccessor, ResourceRevisionAccessor, ScreenInputAccessor, UserAccessor, ViewModelAccessor

All Known Implementing Classes:

AbstractCRUDAccessor, AbstractRemoteCRUDAccessorImpl, ControllerSettingAccessorImpl, ExecutionAccessorImpl, ExecutionTaskAccessorImpl, FunctionAccessorImpl, InMemoryControllerSettingAccessor, InMemoryCRUDAccessor, InMemoryExecutionAccessor, InMemoryExecutionTaskAccessor, InMemoryFunctionAccessorImpl, InMemoryPlanAccessor, InMemoryReportNodeAccessor, InMemoryResourceAccessor, InMemoryResourceRevisionAccessor, InMemoryUserAccessor, InMemoryViewModelAccessor, LayeredCRUDAccessor, LayeredFunctionAccessor, LayeredPlanAccessor, PlanAccessorImpl, RemoteExecutionAccessor, RemoteExecutionAccessorImpl, RemoteFunctionAccessor, RemoteFunctionAccessorImpl, RemoteParameterAccessor, RemoteParameterAccessorImpl, RemotePlanAccessor, RemotePlanAccessorImpl, ReportNodeAccessorImpl, ResourceAccessorImpl, ResourceRevisionAccessorImpl, ScreenInputAccessorImpl, StagingContextAccessorImpl, UserAccessorImpl, ViewModelAccessorImpl

public interface Accessor<T extends AbstractIdentifiableObject>

Method Summary

Modifier and Type	Method	Description
T	findByAttributes(Map<String,String> attributes)	Find an object by default attributes.
T	findByAttributes(Map<String,String> attributes, String attributesMapKey)	Find an object by attributes.
Spliterator<T>	findManyByAttributes(Map<String,String> attributes)	Find objects by attributes.
Spliterator<T>	findManyByAttributes(Map<String,String> attributes, String attributesMapKey)	Find objects by attributes.
T	get(String id)	Get an object by id
T	get(org.bson.types.ObjectId id)	Get an object by id
Iterator<T>	getAll()
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(String id)

Get an object by id

Parameters:

id - the UID of the object

Returns:

the object

findByAttributes

T findByAttributes(Map<String,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

Spliterator<T> findManyByAttributes(Map<String,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

Iterator<T> getAll()

findByAttributes

T findByAttributes(Map<String,String> attributes,
                   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

Spliterator<T> findManyByAttributes(Map<String,String> attributes,
                                    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

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