org.kuali.rice.krms.impl.repository

Class KrmsAttributeDefinitionServiceImpl

java.lang.Object

org.kuali.rice.krms.impl.repository.KrmsAttributeDefinitionServiceImpl

All Implemented Interfaces:

KrmsAttributeDefinitionService

public final class KrmsAttributeDefinitionServiceImpl
extends Object
implements KrmsAttributeDefinitionService

Constructor Summary

Constructors

Constructor and Description
KrmsAttributeDefinitionServiceImpl()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	convertAttributeKeys(Map<String,String> attributesByName, String namespace) This method converts a collection of name/value attribute pairs to id/value attribute pairs.
List<KrmsAttributeDefinition>	convertListOfBosToImmutables(Collection<KrmsAttributeDefinitionBo> krmsAttributeDefinitionBos) Converts a List to an Unmodifiable List
KrmsAttributeDefinition	createAttributeDefinition(KrmsAttributeDefinition attributeDefinition) This will create a KrmsAttributeDefinition exactly like the parameter passed in.
List<KrmsAttributeDefinition>	findAllAttributeDefinitions() Returns all KrmsAttributeDefinitions
List<KrmsAttributeDefinition>	findAttributeDefinitionsByNamespace(String namespace) Returns all KrmsAttributeDefinition that for a given namespace.
List<KrmsAttributeDefinition>	findAttributeDefinitionsByType(String typeId) Returns all KrmsAttributeDefinition that for a given type.
KrmsAttributeDefinition	getAttributeDefinitionById(String id) Lookup a KrmsAttributeDefinition based on the given id.
KrmsAttributeDefinition	getAttributeDefinitionByNameAndNamespace(String name, String namespace) Get a KrmsAttributeDefinition object based on name and namespace
protected DataObjectService	getDataObjectService() This method returns a reference to the dataObjectService.
KrmsAttributeDefinitionBo	getKrmsAttributeBo(String attributeName, String namespace) This method gets a KrmsAttributeDefinitionBo object for a given attribute.
String	getKrmsAttributeId(String attributeName, String namespace) This method gets the attribute definition ID for a given attribute
void	setDataObjectService(DataObjectService dataObjectService) Sets the dataObjectService attribute value.
void	updateAttributeDefinition(KrmsAttributeDefinition attributeDefinition) This will update a KrmsAttributeDefinition.

Methods inherited from class java.lang.Object

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

Constructor Detail

KrmsAttributeDefinitionServiceImpl

public KrmsAttributeDefinitionServiceImpl()

Method Detail

convertAttributeKeys

public Map<String,String> convertAttributeKeys(Map<String,String> attributesByName,
                                               String namespace)

Description copied from interface: KrmsAttributeDefinitionService

This method converts a collection of name/value attribute pairs to id/value attribute pairs.

At the api layer, attributes are represented as name/value pairs. However, in the database, the names of the attribute and the values are stored separately. The attribute definitions contain the attribute names. All defined attributes(for the various krms entity types) are stored together in a single table. The attribute values themselves are stored in separate tables for each entity type, and then reference the attribute definitions by the attribute definition id.

This method converts the name/value pairs to id/value pairs so they can be searched from a single table. This simplifies the queries for attributes.

Specified by:

convertAttributeKeys in interface KrmsAttributeDefinitionService

Parameters:

attributesByName - - a Map containing the name/value pairs for the set of attributes.

namespace - - the namespace code of the set of attributes

Returns:

a Map containing the id/value pairs for the set of attributes.

See Also:

KrmsAttributeDefinitionService.convertAttributeKeys(java.util.Map, String)

getKrmsAttributeId

public String getKrmsAttributeId(String attributeName,
                                 String namespace)

Description copied from interface: KrmsAttributeDefinitionService

This method gets the attribute definition ID for a given attribute

Specified by:

getKrmsAttributeId in interface KrmsAttributeDefinitionService

Parameters:

attributeName - - the name of the attribute

namespace - - the namespace code of the attribute

Returns:

- the attribute definition id

See Also:

KrmsAttributeDefinitionService.getKrmsAttributeId(String, String)

getKrmsAttributeBo

public KrmsAttributeDefinitionBo getKrmsAttributeBo(String attributeName,
                                                    String namespace)

Description copied from interface: KrmsAttributeDefinitionService

This method gets a KrmsAttributeDefinitionBo object for a given attribute.

Specified by:

getKrmsAttributeBo in interface KrmsAttributeDefinitionService

Parameters:

attributeName - - the name of the attribute

namespace - - the namespace code of the attribute

Returns:

- the attribute definition id

See Also:

KrmsAttributeDefinitionService.getKrmsAttributeBo(String, String)

createAttributeDefinition

public KrmsAttributeDefinition createAttributeDefinition(KrmsAttributeDefinition attributeDefinition)

Description copied from interface: KrmsAttributeDefinitionService

This will create a KrmsAttributeDefinition exactly like the parameter passed in.

Specified by:

createAttributeDefinition in interface KrmsAttributeDefinitionService

Parameters:

attributeDefinition - - KrmsAttributeDefinition

See Also:

KrmsAttributeDefinitionService.createAttributeDefinition(org.kuali.rice.krms.api.repository.type.KrmsAttributeDefinition)

updateAttributeDefinition

public void updateAttributeDefinition(KrmsAttributeDefinition attributeDefinition)

Description copied from interface: KrmsAttributeDefinitionService

This will update a KrmsAttributeDefinition.

Specified by:

updateAttributeDefinition in interface KrmsAttributeDefinitionService

Parameters:

attributeDefinition - - KrmsAttributeDefinition

See Also:

KrmsAttributeDefinitionService.updateAttributeDefinition(org.kuali.rice.krms.api.repository.type.KrmsAttributeDefinition)

getAttributeDefinitionById

public KrmsAttributeDefinition getAttributeDefinitionById(String id)

Description copied from interface: KrmsAttributeDefinitionService

Lookup a KrmsAttributeDefinition based on the given id.

Specified by:

getAttributeDefinitionById in interface KrmsAttributeDefinitionService

Parameters:

id - the given KrmsAttributeDefinition id

Returns:

a KrmsAttributeDefinition object with the given id. A null reference is returned if an invalid or non-existant id is supplied.

See Also:

KrmsAttributeDefinitionService.getAttributeDefinitionById(String)

getAttributeDefinitionByNameAndNamespace

public KrmsAttributeDefinition getAttributeDefinitionByNameAndNamespace(String name,
                                                                        String namespace)

Description copied from interface: KrmsAttributeDefinitionService

Get a KrmsAttributeDefinition object based on name and namespace

Specified by:

getAttributeDefinitionByNameAndNamespace in interface KrmsAttributeDefinitionService

Parameters:

name - the given name

namespace - the given type namespace

Returns:

A KrmsAttributeDefinition object with the given namespace and name if one with that name and namespace exists. Otherwise, null is returned.

See Also:

KrmsAttributeDefinitionService.getAttributeDefinitionByNameAndNamespace(String, String)

findAttributeDefinitionsByNamespace

public List<KrmsAttributeDefinition> findAttributeDefinitionsByNamespace(String namespace)

Description copied from interface: KrmsAttributeDefinitionService

Returns all KrmsAttributeDefinition that for a given namespace.

Specified by:

findAttributeDefinitionsByNamespace in interface KrmsAttributeDefinitionService

Returns:

all KrmsAttributeDefinition for a namespace

See Also:

KrmsAttributeDefinitionService.findAttributeDefinitionsByNamespace(String)

findAttributeDefinitionsByType

public List<KrmsAttributeDefinition> findAttributeDefinitionsByType(String typeId)

Description copied from interface: KrmsAttributeDefinitionService

Returns all KrmsAttributeDefinition that for a given type.

Specified by:

findAttributeDefinitionsByType in interface KrmsAttributeDefinitionService

Returns:

all KrmsAttributeDefinition for a type. May be empty, will not be null;

findAllAttributeDefinitions

public List<KrmsAttributeDefinition> findAllAttributeDefinitions()

Description copied from interface: KrmsAttributeDefinitionService

Returns all KrmsAttributeDefinitions

Specified by:

findAllAttributeDefinitions in interface KrmsAttributeDefinitionService

Returns:

all KrmsAttributeDefinitions

See Also:

KrmsAttributeDefinitionService.findAllAttributeDefinitions()

convertListOfBosToImmutables

public List<KrmsAttributeDefinition> convertListOfBosToImmutables(Collection<KrmsAttributeDefinitionBo> krmsAttributeDefinitionBos)

Converts a List to an Unmodifiable List

Parameters:

krmsAttributeDefinitionBos - a mutable List to made completely immutable.

Returns:

An unmodifiable List

setDataObjectService

public void setDataObjectService(DataObjectService dataObjectService)

Sets the dataObjectService attribute value.

Parameters:

dataObjectService - The dataObjectService to set.

getDataObjectService

protected DataObjectService getDataObjectService()

This method returns a reference to the dataObjectService. If the dataObjectService is not set, get it from the KRADServiceLocator.

Returns:

dataObjectService