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

java.lang.Object
  extended by 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
protected  String attributeName
           
protected  String entryName
           
 
Constructor Summary
BaseAttributeValueReader()
           
 
Method Summary
abstract  AttributeValueReader clone()
           
 String getAttributeName()
          This method is an accessor for the attribute name that is currently being processed by the DictionaryValidationService implementation.
 List<String> getCleanSearchableValues(String attributeKey)
          A method to enable legacy processing of string representations of attribute values like a date range in the format 12/03/2001..1/29/2009
 String getEntryName()
          An entry name should be returned for the purposes of correcting looking up errors, which are generally found by entry name + attribute name + error key.
 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
A method to enable 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
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
This method is 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
An entry name should be returned for the purposes of correcting looking up errors, which are generally found by entry name + attribute name + error key.

Specified by:
getEntryName in interface AttributeValueReader
Returns:
the entryName

clone

public abstract AttributeValueReader clone()
Specified by:
clone in interface AttributeValueReader
Overrides:
clone in class Object


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.