org.apache.airavata.persistance.registry.jpa.impl

Class RegistryImpl

java.lang.Object

org.apache.airavata.persistance.registry.jpa.impl.RegistryImpl

All Implemented Interfaces:

Registry

public class RegistryImpl
extends Object
implements Registry

Constructor Summary

Constructors

Constructor and Description
RegistryImpl()
RegistryImpl(String gateway, String username, String password)

Method Summary

Methods

Modifier and Type	Method and Description
Object	add(ChildDataType dataType, Object newObjectToAdd, Object dependentIdentifier) This method is to add an object in to the registry
Object	add(ParentDataType dataType, Object newObjectToAdd) This method is to add an object in to the registry
Object	get(RegistryModelType dataType, Object identifier) This method is to retrieve object according to the identifier.
List<Object>	get(RegistryModelType dataType, String fieldName, Object value) This method is to retrieve list of objects according to a given criteria
List<String>	getIds(RegistryModelType dataType, String fieldName, Object value) This method is to retrieve all the identifiers according to given filtering criteria.
Object	getValue(RegistryModelType dataType, Object identifier, String field) This method is to retrieve a specific value for a given field.
boolean	isExist(RegistryModelType dataType, Object identifier) This method will check whether a given data type which can be identified with the identifier exists or not
void	remove(RegistryModelType dataType, Object identifier) This method is to remove a item from the registry
List<Object>	search(RegistryModelType dataType, Map<String,String> filters)
void	update(RegistryModelType dataType, Object newObjectToUpdate, Object identifier) This method is to update the whole object in registry
void	update(RegistryModelType dataType, Object identifier, String fieldName, Object value) This method is to update a specific field of the data model

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegistryImpl

public RegistryImpl()
             throws RegistryException

Throws:

RegistryException

RegistryImpl

public RegistryImpl(String gateway,
            String username,
            String password)
             throws RegistryException

Throws:

RegistryException

Method Detail

add

public Object add(ParentDataType dataType,
         Object newObjectToAdd)
           throws RegistryException

This method is to add an object in to the registry

Specified by:

add in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

newObjectToAdd - Object which contains the fields that need to be saved in to registry. This object is a thrift model object. In experiment case this object can be BasicMetadata, ConfigurationData etc

Returns:

return the identifier to identify the object

Throws:

RegistryException

add

public Object add(ChildDataType dataType,
         Object newObjectToAdd,
         Object dependentIdentifier)
           throws RegistryException

This method is to add an object in to the registry

Specified by:

add in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

newObjectToAdd - Object which contains the fields that need to be saved in to registry. This object is a thrift model object. In experiment case this object can be BasicMetadata, ConfigurationData etc

dependentIdentifier - Object which contains the identifier if the object that is going to add is not a top level object in the data model. If it is a top level object, programmer can pass it as null

Throws:

RegistryException

update

public void update(RegistryModelType dataType,
          Object newObjectToUpdate,
          Object identifier)
            throws RegistryException

This method is to update the whole object in registry

Specified by:

update in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

newObjectToUpdate - Object which contains the fields that need to be updated in to registry. This object is a thrift model object. In experiment case this object can be BasicMetadata, ConfigurationData etc. CPI programmer can only fill necessary fields that need to be updated. He does not have to fill the whole object. He needs to only fill the mandatory fields and whatever the other fields that need to be updated.

Throws:

RegistryException

update

public void update(RegistryModelType dataType,
          Object identifier,
          String fieldName,
          Object value)
            throws RegistryException

This method is to update a specific field of the data model

Specified by:

update in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

identifier - Identifier which will uniquely identify the data model. For example, in Experiment_Basic_Type, identifier will be generated experimentID

fieldName - Field which need to be updated in the registry. In Experiment_Basic_Type, if you want to update the description, field will be "description". Field names are defined in org.apache.airavata.registry.cpi.utils.Constants

value - Value by which the given field need to be updated. If the field is "description", that field will be updated by given value

Throws:

RegistryException

get

public Object get(RegistryModelType dataType,
         Object identifier)
           throws RegistryException

This method is to retrieve object according to the identifier. In the experiment basic data type, if you give the experiment id, this method will return the BasicMetadata object

Specified by:

get in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

identifier - Identifier which will uniquely identify the data model. For example, in Experiment_Basic_Type, identifier will be generated experimentID

Returns:

object according to the given identifier.

Throws:

RegistryException

get

public List<Object> get(RegistryModelType dataType,
               String fieldName,
               Object value)
                 throws RegistryException

This method is to retrieve list of objects according to a given criteria

Specified by:

get in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

fieldName - FieldName is the field that filtering should be done. For example, if we want to retrieve all the experiments for a given user, filterBy will be "userName"

value - value for the filtering field. In the experiment case, value for "userName" can be "admin"

Returns:

List of objects according to the given criteria

Throws:

RegistryException

search

public List<Object> search(RegistryModelType dataType,
                  Map<String,String> filters)
                    throws RegistryException

Specified by:

search in interface Registry

Throws:

RegistryException

getValue

public Object getValue(RegistryModelType dataType,
              Object identifier,
              String field)
                throws RegistryException

This method is to retrieve a specific value for a given field.

Specified by:

getValue in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

identifier - Identifier which will uniquely identify the data model. For example, in Experiment_Basic_Type, identifier will be generated experimentID

field - field that filtering should be done. For example, if we want to execution user for a given experiment, field will be "userName"

Returns:

return the value for the specific field where data model is identified by the unique identifier that has given

Throws:

RegistryException

getIds

public List<String> getIds(RegistryModelType dataType,
                  String fieldName,
                  Object value)
                    throws RegistryException

This method is to retrieve all the identifiers according to given filtering criteria. For an example, if you want to get all the experiment ids for a given gateway, your field name will be "gateway" and the value will be the name of the gateway ("default"). Similar manner you can retrieve all the experiment ids for a given user.

Specified by:

getIds in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

fieldName - FieldName is the field that filtering should be done. For example, if we want to retrieve all the experiments for a given user, filterBy will be "userName"

value - value for the filtering field. In the experiment case, value for "userName" can be "admin"

Returns:

id list according to the filtering criteria

Throws:

RegistryException

remove

public void remove(RegistryModelType dataType,
          Object identifier)
            throws RegistryException

This method is to remove a item from the registry

Specified by:

remove in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

identifier - Identifier which will uniquely identify the data model. For example, in Experiment_Basic_Type, identifier will be generated experimentID

Throws:

RegistryException

isExist

public boolean isExist(RegistryModelType dataType,
              Object identifier)
                throws RegistryException

This method will check whether a given data type which can be identified with the identifier exists or not

Specified by:

isExist in interface Registry

Parameters:

dataType - Data type is a predefined type which the programmer should choose according to the object he is going to save in to registry

identifier - Identifier which will uniquely identify the data model. For example, in Experiment_Basic_Type, identifier will be generated experimentID

Returns:

whether the given data type exists or not

Throws:

RegistryException