org.kuali.rice.krad.datadictionary.validation

Class BaseAttributeValueReader

java.lang.Object

org.kuali.rice.krad.datadictionary.validation.BaseAttributeValueReader

All Implemented Interfaces:

AttributeValueReader

Direct Known Subclasses:

DictionaryObjectAttributeValueReader, SingleAttributeValueReader, ViewAttributeValueReader

public abstract class BaseAttributeValueReader
extends Object
implements AttributeValueReader

A class that implements the required accessors and legacy processing for an attribute value reader. This provides a convenient base class from which other attribute value readers can be derived.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attributeName
protected String	entryName

Constructor Summary

Constructors

Constructor and Description
BaseAttributeValueReader()

Method Summary

Methods

Modifier and Type	Method and Description
abstract AttributeValueReader	clone() overrides Object.clone()
String	getAttributeName() acts as an accessor for the attribute name that is currently being processed by the DictionaryValidationService implementation
List<String>	getCleanSearchableValues(String attributeKey) enables legacy processing of string representations of attribute values like a date range in the format 12/03/2001..1/29/2009
String	getEntryName() gets the entry name for the purposes of correct error look up
void	setAttributeName(String currentName) Setter for the current attribute that is being processed

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.datadictionary.validation.AttributeValueReader

getDefinition, getDefinitions, getEntry, getLabel, getObject, getPath, getType, getValue, getValue, isReadable

Field Detail

entryName

protected String entryName

attributeName

protected String attributeName

Constructor Detail

BaseAttributeValueReader

public BaseAttributeValueReader()

Method Detail

getCleanSearchableValues

public List<String> getCleanSearchableValues(String attributeKey)
                                      throws AttributeValidationException

Description copied from interface: AttributeValueReader

enables legacy processing of string representations of attribute values like a date range in the format 12/03/2001..1/29/2009

Specified by:

getCleanSearchableValues in interface AttributeValueReader

Parameters:

attributeKey - - the attribute name

Returns:

the list of token strings for the attribute value of the named attribute

Throws:

AttributeValidationException

getAttributeName

public String getAttributeName()

Description copied from interface: AttributeValueReader

acts as an accessor for the attribute name that is currently being processed by the DictionaryValidationService implementation

Specified by:

getAttributeName in interface AttributeValueReader

Returns:

the currentName

setAttributeName

public void setAttributeName(String currentName)

Description copied from interface: AttributeValueReader

Setter for the current attribute that is being processed

Specified by:

setAttributeName in interface AttributeValueReader

Parameters:

currentName - the currentName to set

getEntryName

public String getEntryName()

Description copied from interface: AttributeValueReader

gets the entry name for the purposes of correct error look up

Errors are generally found by entry name + attribute name + error key

Specified by:

getEntryName in interface AttributeValueReader

Returns:

the entryName

clone

public abstract AttributeValueReader clone()

Description copied from interface: AttributeValueReader

overrides Object.clone()

Specified by:

clone in interface AttributeValueReader

Overrides:

clone in class Object

Returns:

a cloned AttributeValueReader