Built-in search attribute extractor driven by method/value dotted expression chains.

The expression chain must start with one of either "key", "value", or "element". From the starting object a chain of either method calls or field names follows. Method calls and field names can be freely mixed in the chain. Some examples:

"key.getName()" -- call getName() on the key object
"value.person.getAge()" -- get the "person" field of the value object and call getAge() on it
"element.toString()" -- call toString() on the element

The method and field name portions of the expression are case sensitive

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ReflectionAttributeExtractor.FieldPart A field expression part
private static class	ReflectionAttributeExtractor.FieldRef A reference to a resolved Field instance
private static class	ReflectionAttributeExtractor.MethodPart A method expression part
private static class	ReflectionAttributeExtractor.MethodRef A reference to a resolved Method instance
private static interface	ReflectionAttributeExtractor.Part A part (method or field) of the expression
private static enum	ReflectionAttributeExtractor.StartType The various types of the start of the expression

Field Summary

Modifier and Type	Field and Description
private static final String	ELEMENT
private static final String	KEY
private final ReflectionAttributeExtractor.Part[]	parts
private final ReflectionAttributeExtractor.StartType	start
private static final String	VALUE

Access	Constructor and Description
public	ReflectionAttributeExtractor(String expression) Create a new ReflectionAttributeExtractor

Method Summary

Modifier and Type	Method and Description
public Object	Returns: the attribute value attributeFor(Element the cache element to inspect e, String the name of the requested attribute attributeName) Implements net.sf.ehcache.search.attribute.AttributeExtractor.attributeFor. Evaluate the expression for the given element
private static ReflectionAttributeExtractor.Part[]	parseExpression(String[] tokens, String expression)
private static void	verifyToken(String token, String expression)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ELEMENT	back to summary
private static final String ELEMENT

KEY	back to summary
private static final String KEY

parts	back to summary
private final ReflectionAttributeExtractor.Part[] parts

start	back to summary
private final ReflectionAttributeExtractor.StartType start

VALUE	back to summary
private static final String VALUE

ReflectionAttributeExtractor	back to summary
public ReflectionAttributeExtractor(String expression) throws InvalidConfigurationException Create a new ReflectionAttributeExtractor

Method Detail

attributeFor	back to summary
public Object attributeFor(Element e, String attributeName) throws AttributeExtractorException Implements net.sf.ehcache.search.attribute.AttributeExtractor.attributeFor. Evaluate the expression for the given element Parameters e:Element Doc from net.sf.ehcache.search.attribute.AttributeExtractor.attributeFor. the cache element to inspect attributeName:String Doc from net.sf.ehcache.search.attribute.AttributeExtractor.attributeFor. the name of the requested attribute Returns:Object the attribute value Exceptions AttributeExtractorException: if there is an error in evaluating the expression

attributeFor

back to summary

public Object attributeFor(Element e, String attributeName) throws AttributeExtractorException

Implements net.sf.ehcache.search.attribute.AttributeExtractor.attributeFor.

Evaluate the expression for the given element

Parameters

e:Element

Doc from net.sf.ehcache.search.attribute.AttributeExtractor.attributeFor.

the cache element to inspect

attributeName:String

Doc from net.sf.ehcache.search.attribute.AttributeExtractor.attributeFor.

the name of the requested attribute

Returns:Object

the attribute value

Exceptions

AttributeExtractorException:: if there is an error in evaluating the expression

parseExpression	back to summary
private static ReflectionAttributeExtractor.Part[] parseExpression(String[] tokens, String expression)

verifyToken	back to summary
private static void verifyToken(String token, String expression)

net.sf.ehcache.search.attribute back to summary

private Class ReflectionAttributeExtractor.FieldPart

Class Inheritance

extends Object
implements Part

java.lang.Object
net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.FieldPart

All Implemented Interfaces

net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.Part, java.io.Serializable

A field expression part

Field Summary

Modifier and Type	Field and Description
private transient volatile ReflectionAttributeExtractor.FieldRef	cache
private final String	fieldName

Constructor Summary

Access	Constructor and Description
public	FieldPart(String field)

Method Summary

Modifier and Type	Method and Description
public Object	eval(Object target) Implements net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.Part.eval.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cache	back to summary
private transient volatile ReflectionAttributeExtractor.FieldRef cache

fieldName	back to summary
private final String fieldName

Constructor Detail

FieldPart	back to summary
public FieldPart(String field)

Method Detail

eval	back to summary
public Object eval(Object target) Implements net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.Part.eval.

net.sf.ehcache.search.attribute back to summary

private Class ReflectionAttributeExtractor.FieldRef

Class Inheritance

extends Object

java.lang.Object
net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.FieldRef

A reference to a resolved Field instance

Field Summary

Modifier and Type	Field and Description
private final Field	field
private final Class<T>	target

Constructor Summary

Access	Constructor and Description
pack-priv	FieldRef(Class<T> target, Field field)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

field	back to summary
private final Field field

target	back to summary
private final Class<T> target

Constructor Detail

FieldRef	back to summary
pack-priv FieldRef(Class<T> target, Field field)

net.sf.ehcache.search.attribute back to summary

private Class ReflectionAttributeExtractor.MethodPart

Class Inheritance

extends Object
implements Part

java.lang.Object
net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.MethodPart

All Implemented Interfaces

net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.Part, java.io.Serializable

A method expression part

Field Summary

Modifier and Type	Field and Description
private transient volatile ReflectionAttributeExtractor.MethodRef	cache
private final String	methodName

Constructor Summary

Access	Constructor and Description
public	MethodPart(String method)

Method Summary

Modifier and Type	Method and Description
public Object	eval(Object target) Implements net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.Part.eval.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cache	back to summary
private transient volatile ReflectionAttributeExtractor.MethodRef cache

methodName	back to summary
private final String methodName

Constructor Detail

MethodPart	back to summary
public MethodPart(String method)

Method Detail

eval	back to summary
public Object eval(Object target) Implements net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.Part.eval.

net.sf.ehcache.search.attribute back to summary

private Class ReflectionAttributeExtractor.MethodRef

Class Inheritance

extends Object

java.lang.Object
net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.MethodRef

A reference to a resolved Method instance

Field Summary

Modifier and Type	Field and Description
private final Method	method
private final Class<T>	target

Constructor Summary

Access	Constructor and Description
pack-priv	MethodRef(Class<T> target, Method method)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

method	back to summary
private final Method method

target	back to summary
private final Class<T> target

Constructor Detail

MethodRef	back to summary
pack-priv MethodRef(Class<T> target, Method method)

net.sf.ehcache.search.attribute back to summary

private Interface ReflectionAttributeExtractor.Part

Known Direct Implementers: net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.FieldPart, net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.MethodPart

A part (method or field) of the expression

Method Summary

Modifier and Type	Method and Description
public Object	eval(Object target)

Method Detail

eval	back to summary
public Object eval(Object target)

net.sf.ehcache.search.attribute back to summary

private final Enum ReflectionAttributeExtractor.StartType

Class Inheritance

extends Enum<ReflectionAttributeExtractor.StartType>

java.lang.Object
java.lang.Enum
net.sf.ehcache.search.attribute.ReflectionAttributeExtractor.StartType

The various types of the start of the expression

Field Summary

Modifier and Type	Field and Description
public static final ReflectionAttributeExtractor.StartType	ELEMENT
public static final ReflectionAttributeExtractor.StartType	KEY
public static final ReflectionAttributeExtractor.StartType	VALUE

Constructor Summary

Access	Constructor and Description
private	StartType()

Method Summary

Modifier and Type	Method and Description
public static ReflectionAttributeExtractor.StartType	valueOf(String name)
public static ReflectionAttributeExtractor.StartType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ELEMENT	back to summary
public static final ReflectionAttributeExtractor.StartType ELEMENT

KEY	back to summary
public static final ReflectionAttributeExtractor.StartType KEY

VALUE	back to summary
public static final ReflectionAttributeExtractor.StartType VALUE

Constructor Detail

StartType	back to summary
private StartType()

Method Detail

valueOf	back to summary
public static ReflectionAttributeExtractor.StartType valueOf(String name)

values	back to summary
public static ReflectionAttributeExtractor.StartType[] values()

public Class ReflectionAttributeExtractor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReflectionAttributeExtractor.FieldPart

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReflectionAttributeExtractor.FieldRef

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class ReflectionAttributeExtractor.MethodPart

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReflectionAttributeExtractor.MethodRef

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Interface ReflectionAttributeExtractor.Part

Method Summary

Method Detail

private final Enum ReflectionAttributeExtractor.StartType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail