Package net.sf.ehcache.config

Class SearchAttribute

  • public class SearchAttribute
extends java.lang.Object
    A cache search attribute. Search attributes must have a name and optionally an expression or class set (if neither is set then this implies java bean style)
    Author:
    teck

    • Constructor Detail

      • SearchAttribute

        public SearchAttribute()

    • Method Detail

      • setName

        public void setName​(java.lang.String name)
        Set the attribute name
        Parameters:
        name -

      • setClass

        public void setClass​(java.lang.String className)
        Set the extractor class for this attribute. This class must be available at runtime and must implement AttributeExtractor
        Parameters:
        className -

      • setExpression

        public void setExpression​(java.lang.String expression)
        Set the attribute expression. See ReflectionAttributeExtractor for more information
        Parameters:
        expression -

      • setType

        public void setType​(java.lang.String type)
        Set optional attribute type
        Parameters:
        type -

      • setType

        public void setType​(java.lang.Class<?> type)
        Set optional attribute type
        Parameters:
        type -

      • getClassName

        public java.lang.String getClassName()
        Get the extractor class name

      • getExpression

        public java.lang.String getExpression()
        Get the attribute expression

      • getName

        public java.lang.String getName()
        Get the attribute name

      • getTypeName

        public java.lang.String getTypeName()
        Returns:
        String representation of attribute type

      • constructExtractor

        public AttributeExtractor constructExtractor​(java.lang.ClassLoader loader)
        Construct the extractor for this attribute configuration

      • name

        public SearchAttribute name​(java.lang.String name)
        Set the attribute name
        Parameters:
        name -
        Returns:
        this

      • className

        public SearchAttribute className​(java.lang.String className)
        Set the attribute extractor class name
        Parameters:
        className - attribute extractor class
        Returns:
        this

      • expression

        public SearchAttribute expression​(java.lang.String expression)
        Set the attribute expression
        Parameters:
        expression - attribute expression
        Returns:
        this

      • type

        public SearchAttribute type​(java.lang.String type)
        Set optional attribute type
        Parameters:
        type -
        Returns:
        this

      • type

        public SearchAttribute type​(java.lang.Class<?> type)
        Set optional attribute type
        Parameters:
        type -
        Returns:
        this

      • setProperties

        public void setProperties​(java.lang.String props)
        Set the extractor properties
        Parameters:
        props -

      • setPropertySeparator

        public void setPropertySeparator​(java.lang.String sep)
        Set the extractor properties separator
        Parameters:
        sep -

      • propertySeparator

        public SearchAttribute propertySeparator​(java.lang.String sep)
        Set the extractor properties separator
        Parameters:
        sep -
        Returns:
        this

      • properties

        public SearchAttribute properties​(java.lang.String props)
        Set the extractor properties
        Parameters:
        props -
        Returns:
        this

      • asConfigElement

        public NodeElement asConfigElement​(NodeElement parent)
        Create a generated config element node for this search attribute definition
        Parameters:
        parent - the enclosing parent config element
        Returns:
        generated config element for this search attribute