01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */package org.apache.solr.schema;
17:
18: import org.apache.lucene.document.Field;
19: import org.apache.lucene.document.Fieldable;
20:
21: import org.apache.solr.request.*;
22:
23: import java.util.Map;
24: import java.io.IOException;
25:
26: /** <code>CompressableField</code> is an abstract field type which enables a
27: * field to be compressed (by specifying <code>compressed="true"</code> at the
28: * field definition level) and provides optional support for specifying a
29: * threshold at which compression is enabled.
30: *
31: * Optional settings:
32: * <ul>
33: * <li><code>compressThreshold</code>: length, in characters, at which point the
34: * field contents should be compressed [default: 0]</li>
35: * </ul></p>
36: *
37: * TODO: Enable compression level specification (not yet in lucene)
38: *
39: * @author klaas
40: * @version $Id: CompressableField.java 479793 2006-11-27 22:40:21Z klaas $
41: */
42: public abstract class CompressableField extends FieldType {
43: /* if field size (in characters) is greater than this threshold, the field
44: will be stored compressed */
45: public static int DEFAULT_COMPRESS_THRESHOLD = 0;
46:
47: int compressThreshold;
48:
49: private static String CT = "compressThreshold";
50:
51: protected void init(IndexSchema schema, Map<String, String> args) {
52: SolrParams p = new MapSolrParams(args);
53: compressThreshold = p.getInt(CT, DEFAULT_COMPRESS_THRESHOLD);
54: args.remove(CT);
55: super .init(schema, args);
56: }
57:
58: /* Helpers for field construction */
59: protected Field.Store getFieldStore(SchemaField field,
60: String internalVal) {
61: /* compress field if length exceeds threshold */
62: if (field.isCompressed()) {
63: return internalVal.length() >= compressThreshold ? Field.Store.COMPRESS
64: : Field.Store.YES;
65: } else
66: return super.getFieldStore(field, internalVal);
67: }
68: }
|