View Javadoc

1   /***
2    *  Copyright 2003-2010 Terracotta, Inc.
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  
17  package net.sf.ehcache.search.attribute;
18  
19  import net.sf.ehcache.Element;
20  
21  /***
22   * Attempt to use the element key object itself as a search attribute. If the key is not a legal type it is omitted
23   *
24   * @author teck
25   */
26  public class KeyObjectAttributeExtractor implements AttributeExtractor {
27  
28      /***
29       * {@inheritDoc}
30       */
31      public Object attributeFor(Element element, String attributeName) throws AttributeExtractorException {
32          Object key = element.getObjectKey();
33  
34          if (AttributeType.isSupportedType(key)) {
35              return key;
36          }
37  
38          // not a supported type return null to not define anything in the index
39          return null;
40      }
41  
42  }