Top Description Methods
net.sf.ehcache.search.attribute

public Interface AttributeExtractor

extends Serializable
Known Direct Implementers
net.sf.ehcache.search.attribute.JavaBeanAttributeExtractor, net.sf.ehcache.search.attribute.KeyObjectAttributeExtractor, net.sf.ehcache.search.attribute.ReflectionAttributeExtractor, net.sf.ehcache.search.attribute.ValueObjectAttributeExtractor
Imports
java.io.Serializable, net.sf.ehcache.Element
Used to extract a search attribute value for a given cache element.

Instances must be Serializable in order to ensure identical extractors are used in distributed caches
Author
teck

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

the attribute value
attributeFor(Element
the cache element to inspect
element, String
the name of the requested attribute
attributeName)

Extract the attribute value.

Method Detail

attributeForback to summary
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

Parameters
element:Element

the cache element to inspect

attributeName:String

the name of the requested attribute

Returns:Object

the attribute value

Exceptions
AttributeExtractorException:
if the attribute cannot be found or extracted