net.sf.ehcache.search.attribute

Class JavaBeanAttributeExtractor

java.lang.Object

net.sf.ehcache.search.attribute.JavaBeanAttributeExtractor

All Implemented Interfaces:

Serializable, AttributeExtractor

public class JavaBeanAttributeExtractor
extends Object
implements AttributeExtractor

Extracts a search attribute determining the value as a javabean property on either the key or the value. If the property exists on both the key and the value an exception is thrown

Author:

teck

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JavaBeanAttributeExtractor(String beanProperty) Constructor

Method Summary

Modifier and Type	Method and Description
Object	attributeFor(Element element, String attributeName) Extract the attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaBeanAttributeExtractor

public JavaBeanAttributeExtractor(String beanProperty)

Constructor

Parameters:

beanProperty - the bean property name to extract

Method Detail

attributeFor

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

Extract the attribute value. The instance returned from this method must be one of:

• java.lang.Boolean
• java.lang.Byte
• java.lang.Character
• java.lang.Double
• java.lang.Float
• java.lang.Integer
• java.lang.Long
• java.lang.Short
• java.lang.String
• java.util.Date
• java.sql.Date
• java.lang.Enum

NOTE: null is a legal return here as well indicating that this attribute will not be available for the given element

Specified by:

attributeFor in interface AttributeExtractor

Parameters:

element - the cache element to inspect

attributeName - the name of the requested attribute

Returns:

the attribute value

Throws:

AttributeExtractorException - if the attribute cannot be found or extracted