org.milyn.scribe

Interface Locator

public interface Locator

The Locator interface

Provides methods for locating entities. A name references the method of how to locate the entity.

Author:

maurice.zeijen@smies.com

Method Summary

Modifier and Type	Method and Description
Object	lookup(String name, Map<String,?> parameters) Looks up one or more entities.
Object	lookup(String name, Object... parameters) Looks up one or more entities.

Method Detail

lookup

Object lookup(String name,
              Object... parameters)

Looks up one or more entities.

If one entity is located then the object should directly be returned. If multiple are located then a 'Collection', containing the entities, should be returned. If no entities are located then null should be returned.

Parameters:

name - the name that indicates how to do the lookup

parameters - the array of parameters

Returns:

the located entity, a collection of located entities or null if no entities are located.

Throws:

OperationNotSupportedException - if the operation is not supported

lookup

Object lookup(String name,
              Map<String,?> parameters)

Looks up one or more entities.

If one entity is located then the object should directly be returned. If multiple are located then a 'Collection', containing the entities, should be returned. If no entities are located then null should be returned.

Parameters:

name - the name that indicates how to do the lookup

parameters - the map of parameters

Returns:

the located entity, a collection of located entities or null if no entities are located.

Throws:

OperationNotSupportedException - if the operation is not supported