com.neurosys.lookups

Class AbstractCategoryLookup<T extends IHierarchialReference>

java.lang.Object

com.neurosys.lookups.AbstractCategoryLookup<T>

All Implemented Interfaces:

org.apache.commons.collections.Transformer

Direct Known Subclasses:

ContentCategoryLookup, ProductCategoryLookup

public abstract class AbstractCategoryLookup<T extends IHierarchialReference>
extends Object
implements org.apache.commons.collections.Transformer

Lookup a Category to get Category IHierarchialReference by using any unique field in it
The transform(Object) accepts a value (some unique key), from which the parent object can be derived
This classs does not perform caching, rely on the class extending it to provide any caching ability

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected String	searchBy
protected boolean	throwExceptionOnNull If no result is found it will throw an exception instead of returning a null
protected Class<T>	type

Constructor Summary

Constructors

Constructor and Description
AbstractCategoryLookup()

Method Summary

Modifier and Type	Method and Description
String	getSearchBy() Field name to search by for the lookup
boolean	isThrowExceptionOnNull() If no result is found it will throw an exception instead of returning a null
protected abstract T	query(Object value) Implementation, to define how to query using the query object
void	setSearchBy(String searchBy) Field name to search by for the lookup
void	setThrowExceptionOnNull(boolean throwExceptionOnNull) If no result is found it will throw an exception instead of returning a null
Object	transform(Object in) For a Given String mnemonic code lookup the Hierarchy of the Category

Methods inherited from class java.lang.Object

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

Field Detail

searchBy

protected String searchBy

type

protected Class<T extends IHierarchialReference> type

throwExceptionOnNull

protected boolean throwExceptionOnNull

If no result is found it will throw an exception instead of returning a null

Default value:

true

Constructor Detail

AbstractCategoryLookup

public AbstractCategoryLookup()

Method Detail

query

protected abstract T query(Object value)
                    throws Exception

Implementation, to define how to query using the query object

Parameters:

value - input object (value to search for) on the searchBy field

Returns:

T as entity

Throws:

Exception

See Also:

Query

transform

public Object transform(Object in)

For a Given String mnemonic code lookup the Hierarchy of the Category

Specified by:

transform in interface org.apache.commons.collections.Transformer

Parameters:

in - as value (some unique key), from which the parent object can be derived

getSearchBy

public String getSearchBy()

Field name to search by for the lookup

setSearchBy

public void setSearchBy(String searchBy)

Field name to search by for the lookup

isThrowExceptionOnNull

public boolean isThrowExceptionOnNull()

If no result is found it will throw an exception instead of returning a null

Default value:

true

setThrowExceptionOnNull

public void setThrowExceptionOnNull(boolean throwExceptionOnNull)

If no result is found it will throw an exception instead of returning a null

Default value:

true