ehcache

net.sf.ehcache.search.attribute
Class JavaBeanAttributeExtractor

java.lang.Object
  extended by 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
JavaBeanAttributeExtractor(String beanProperty)
          Constructor
 
Method Summary
 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:

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

ehcache

Copyright 2001-2014, Terracotta, Inc.