org.kuali.student.r2.common.datadictionary.util

Class CriteriaValidatorParser

java.lang.Object

org.kuali.student.r2.common.datadictionary.util.CriteriaValidatorParser

public class CriteriaValidatorParser
extends Object

A class that validates the criteria against the dictionary It also sets the parsedValues and parsedOperators so they may be used in the implementation The call sequence is sometehing like this:

1. construct this validator
2. Configure this validator with criteria to be valiated
3. Get the dictionary entry of the object to be validated by calling DataDictionaryServiceInfc.getDataDictionaryEntry (the ref object's URI)
4. Configure this validator with the dictionary entry that you just got from the dictionary
5. Call the validate () method which will throw exceptions if problems
6. get the parsed values (@see getParsedValues ()) and use them in the implementation
7. Get the parsed operators and use in the implementation, if you want

Author:

nwright

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CriteriaValidatorParser.Operator

Constructor Summary

Constructors

Constructor and Description
CriteriaValidatorParser()

Method Summary

Methods

Modifier and Type	Method and Description
Criteria	getCriteria()
DictionaryEntry	getDictionaryEntry()
List<CriteriaValidatorParser.Operator>	getParsedOperators() Get the string operators translated as an Operator enum
List<Object>	getParsedValues() The values parsed as their respective data types, String, Date, Integer, etc.
void	setCriteria(Criteria criteria)
void	setDictionaryEntry(DictionaryEntry dictionaryEntry)
void	validate() Validate the criteria thowing an InvalidParameterException if there are problems TODO: Consider getting all the errors and throw them as a group instead of as we find them

Methods inherited from class java.lang.Object

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

Constructor Detail

CriteriaValidatorParser

public CriteriaValidatorParser()

Method Detail

getCriteria

public Criteria getCriteria()

setCriteria

public void setCriteria(Criteria criteria)

getDictionaryEntry

public DictionaryEntry getDictionaryEntry()

setDictionaryEntry

public void setDictionaryEntry(DictionaryEntry dictionaryEntry)

getParsedOperators

public List<CriteriaValidatorParser.Operator> getParsedOperators()

Get the string operators translated as an Operator enum

Returns:

list of operators in the same ordinal position as the supplied operators in the list of ComparisonInfc objects

getParsedValues

public List<Object> getParsedValues()

The values parsed as their respective data types, String, Date, Integer, etc. Special considerations: IN operators return a List of one or more parsed values who's order is the samne as the order in the ComparisonInfc BETWEEN operators return a list of two parsed values who's values coorespond to the from to values of a between operation.

Returns:

a list of parsed values in the same ordinal positions as the unparsed values in the list of ComparisonInfc objects

validate

public void validate()
              throws InvalidParameterException,
                     OperationFailedException

Validate the criteria thowing an InvalidParameterException if there are problems TODO: Consider getting all the errors and throw them as a group instead of as we find them

Throws:

InvalidParameterException

OperationFailedException