- * Additional scoring factors can be stored in named {@link DocValuesField}s, and accessed
+ * Additional scoring factors can be stored in named
+ * *DocValuesFields (such as {@link
+ * ByteDocValuesField} or {@link FloatDocValuesField}), and accessed
* at query-time with {@link AtomicReader#docValues(String)}.
*
* Finally, using index-time boosts (either via folding into the normalization byte or Index: lucene/core/src/java/org/apache/lucene/index/Norm.java =================================================================== --- lucene/core/src/java/org/apache/lucene/index/Norm.java (revision 1334974) +++ lucene/core/src/java/org/apache/lucene/index/Norm.java (working copy) @@ -16,7 +16,17 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import org.apache.lucene.document.DocValuesField; +import org.apache.lucene.document.ByteDocValuesField; +import org.apache.lucene.document.DerefBytesDocValuesField; +import org.apache.lucene.document.DoubleDocValuesField; +import org.apache.lucene.document.Field; +import org.apache.lucene.document.FloatDocValuesField; +import org.apache.lucene.document.IntDocValuesField; +import org.apache.lucene.document.LongDocValuesField; +import org.apache.lucene.document.PackedLongDocValuesField; +import org.apache.lucene.document.ShortDocValuesField; +import org.apache.lucene.document.SortedBytesDocValuesField; +import org.apache.lucene.document.StraightBytesDocValuesField; import org.apache.lucene.index.DocValues.Type; import org.apache.lucene.search.similarities.Similarity; import org.apache.lucene.util.BytesRef; @@ -33,7 +43,7 @@ * @lucene.internal */ public final class Norm { - private DocValuesField field; + private Field field; private BytesRef spare; /** @@ -81,7 +91,7 @@ */ public void setShort(short norm) { setType(Type.FIXED_INTS_16); - this.field.setIntValue(norm); + this.field.setShortValue(norm); } @@ -106,7 +116,7 @@ */ public void setByte(byte norm) { setType(Type.FIXED_INTS_8); - this.field.setIntValue(norm); + this.field.setByteValue(norm); } /** @@ -124,27 +134,47 @@ throw new IllegalArgumentException("FieldType missmatch - expected "+type+" but was " + field.fieldType().docValueType()); } } else { - switch (type) { - case BYTES_FIXED_DEREF: - case BYTES_FIXED_SORTED: - case BYTES_FIXED_STRAIGHT: - case BYTES_VAR_DEREF: - case BYTES_VAR_SORTED: - case BYTES_VAR_STRAIGHT: - this.field = new DocValuesField("", new BytesRef(), type); + + switch(type) { + case VAR_INTS: + field = new PackedLongDocValuesField("", (long) 0); break; - + case FIXED_INTS_8: + field = new ByteDocValuesField("", (byte) 0); + break; case FIXED_INTS_16: + field = new ShortDocValuesField("", (short) 0); + break; case FIXED_INTS_32: + field = new IntDocValuesField("", 0); + break; case FIXED_INTS_64: - case FIXED_INTS_8: - case VAR_INTS: - this.field = new DocValuesField("", 0, type); + field = new LongDocValuesField("", (byte) 0); break; case FLOAT_32: + field = new FloatDocValuesField("", 0f); + break; case FLOAT_64: - this.field = new DocValuesField("", 0f, type); + field = new DoubleDocValuesField("", 0d); break; + case BYTES_FIXED_STRAIGHT: + field = new StraightBytesDocValuesField("", new BytesRef(), true); + break; + case BYTES_VAR_STRAIGHT: + field = new StraightBytesDocValuesField("", new BytesRef(), false); + break; + case BYTES_FIXED_DEREF: + field = new DerefBytesDocValuesField("", new BytesRef(), true); + break; + case BYTES_VAR_DEREF: + field = new DerefBytesDocValuesField("", new BytesRef(), false); + break; + case BYTES_FIXED_SORTED: + field = new SortedBytesDocValuesField("", new BytesRef(), true); + break; + case BYTES_VAR_SORTED: + field = new SortedBytesDocValuesField("", new BytesRef(), false); + break; default: throw new IllegalArgumentException("unknown Type: " + type); } Index: lucene/core/src/java/org/apache/lucene/index/DocValues.java =================================================================== --- lucene/core/src/java/org/apache/lucene/index/DocValues.java (revision 1334974) +++ lucene/core/src/java/org/apache/lucene/index/DocValues.java (working copy) @@ -21,7 +21,16 @@ import java.util.Comparator; import org.apache.lucene.codecs.DocValuesFormat; -import org.apache.lucene.document.DocValuesField; +import org.apache.lucene.document.ByteDocValuesField; // javadocs +import org.apache.lucene.document.DerefBytesDocValuesField; // javadocs +import org.apache.lucene.document.DoubleDocValuesField; // javadocs +import org.apache.lucene.document.FloatDocValuesField; // javadocs +import org.apache.lucene.document.IntDocValuesField; // javadocs +import org.apache.lucene.document.LongDocValuesField; // javadocs +import org.apache.lucene.document.PackedLongDocValuesField; // javadocs +import org.apache.lucene.document.ShortDocValuesField; // javadocs +import org.apache.lucene.document.SortedBytesDocValuesField; // javadocs +import org.apache.lucene.document.StraightBytesDocValuesField; // javadocs import org.apache.lucene.util.BytesRef; import org.apache.lucene.util.packed.PackedInts; @@ -40,7 +49,16 @@ * {@link DocValues} are fully integrated into the {@link DocValuesFormat} API. * * @see Type for limitations and default implementation documentation - * @see DocValuesField for adding values to the index + * @see ByteDocValuesField for adding byte values to the index + * @see ShortDocValuesField for adding short values to the index + * @see IntDocValuesField for adding int values to the index + * @see LongDocValuesField for adding long values to the index + * @see FloatDocValuesField for adding float values to the index + * @see DoubleDocValuesField for adding double values to the index + * @see PackedLongDocValuesField for adding packed long values to the index + * @see SortedBytesDocValuesField for adding sorted {@link BytesRef} values to the index + * @see StraightBytesDocValuesField for adding straight {@link BytesRef} values to the index + * @see DerefBytesDocValuesField for adding deref {@link BytesRef} values to the index * @see DocValuesFormat#docsConsumer(org.apache.lucene.index.PerDocWriteState) for * customization * @lucene.experimental Index: lucene/core/src/java/org/apache/lucene/index/TypePromoter.java =================================================================== --- lucene/core/src/java/org/apache/lucene/index/TypePromoter.java (revision 1334974) +++ lucene/core/src/java/org/apache/lucene/index/TypePromoter.java (working copy) @@ -114,8 +114,8 @@ return create(FLAGS_MAP.get(promoted.flags & PROMOTE_TO_VAR_SIZE_MASK), VAR_TYPE_VALUE_SIZE); } + return promoted; - } /** Index: lucene/core/src/java/org/apache/lucene/document/Field.java =================================================================== --- lucene/core/src/java/org/apache/lucene/document/Field.java (revision 1334974) +++ lucene/core/src/java/org/apache/lucene/document/Field.java (working copy) @@ -38,7 +38,13 @@ * Expert: directly create a field for a document. Most * users should use one of the sugar subclasses: {@link * IntField}, {@link LongField}, {@link FloatField}, {@link - * DoubleField}, {@link DocValuesField}, {@link + * DoubleField}, {@link ByteDocValuesField}, {@link + * ShortDocValuesField}, {@link IntDocValuesField}, {@link + * LongDocValuesField}, {@link PackedLongDocValuesField}, + * {@link FloatDocValuesField}, {@link + * DoubleDocValuesField}, {@link SortedBytesDocValuesField}, + * {@link DerefBytesDocValuesField}, {@link + * StraightBytesDocValuesField}, {@link * StringField}, {@link TextField}, {@link StoredField}. * *
A field is a section of a Document. Each field has three @@ -273,6 +279,26 @@ fieldsData = value; } + public void setByteValue(byte value) { + if (!(fieldsData instanceof Byte)) { + throw new IllegalArgumentException("cannot change value type from " + fieldsData.getClass().getSimpleName() + " to Byte"); + } + if (numericTokenStream != null) { + numericTokenStream.setIntValue(value); + } + fieldsData = Byte.valueOf(value); + } + + public void setShortValue(short value) { + if (!(fieldsData instanceof Short)) { + throw new IllegalArgumentException("cannot change value type from " + fieldsData.getClass().getSimpleName() + " to Short"); + } + if (numericTokenStream != null) { + numericTokenStream.setIntValue(value); + } + fieldsData = Short.valueOf(value); + } + public void setIntValue(int value) { if (!(fieldsData instanceof Integer)) { throw new IllegalArgumentException("cannot change value type from " + fieldsData.getClass().getSimpleName() + " to Integer"); Index: lucene/core/src/java/org/apache/lucene/document/DoubleDocValuesField.java =================================================================== --- lucene/core/src/java/org/apache/lucene/document/DoubleDocValuesField.java (revision 0) +++ lucene/core/src/java/org/apache/lucene/document/DoubleDocValuesField.java (working copy) @@ -0,0 +1,53 @@ +package org.apache.lucene.document; + +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.util.EnumSet; +import java.util.HashMap; +import java.util.Map; + +import org.apache.lucene.index.DocValues; + +/** + *+ * This class provides a {@link Field} that enables storing + * of a per-document double value for scoring, sorting or value retrieval. Here's an + * example usage: + * + *
+ * document.add(new DoubleDocValuesField(name, 22.0)); + *+ * + *
+ * If you also need to store the value, you should add a + * separate {@link StoredField} instance. + * */ + +public class DoubleDocValuesField extends Field { + + public static final FieldType TYPE = new FieldType(); + static { + TYPE.setDocValueType(DocValues.Type.FLOAT_64); + TYPE.freeze(); + } + + public DoubleDocValuesField(String name, double value) { + super(name, TYPE); + fieldsData = Double.valueOf(value); + } +} Index: lucene/core/src/java/org/apache/lucene/document/IntDocValuesField.java =================================================================== --- lucene/core/src/java/org/apache/lucene/document/IntDocValuesField.java (revision 0) +++ lucene/core/src/java/org/apache/lucene/document/IntDocValuesField.java (working copy) @@ -0,0 +1,49 @@ +package org.apache.lucene.document; + +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import org.apache.lucene.index.DocValues; + +/** + *
+ * This class provides a {@link Field} that enables storing + * of a per-document int value for scoring, sorting or value retrieval. Here's an + * example usage: + * + *
+ * document.add(new IntDocValuesField(name, 22)); + *+ * + *
+ * If you also need to store the value, you should add a + * separate {@link StoredField} instance. + * */ + +public class IntDocValuesField extends Field { + + public static final FieldType TYPE = new FieldType(); + static { + TYPE.setDocValueType(DocValues.Type.FIXED_INTS_32); + TYPE.freeze(); + } + + public IntDocValuesField(String name, int value) { + super(name, TYPE); + fieldsData = Integer.valueOf(value); + } +} Index: lucene/core/src/java/org/apache/lucene/document/ShortDocValuesField.java =================================================================== --- lucene/core/src/java/org/apache/lucene/document/ShortDocValuesField.java (revision 0) +++ lucene/core/src/java/org/apache/lucene/document/ShortDocValuesField.java (working copy) @@ -0,0 +1,49 @@ +package org.apache.lucene.document; + +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import org.apache.lucene.index.DocValues; + +/** + *
+ * This class provides a {@link Field} that enables storing + * of a per-document short value for scoring, sorting or value retrieval. Here's an + * example usage: + * + *
+ * document.add(new ShortDocValuesField(name, (short) 22)); + *+ * + *
+ * If you also need to store the value, you should add a + * separate {@link StoredField} instance. + * */ + +public class ShortDocValuesField extends Field { + + public static final FieldType TYPE = new FieldType(); + static { + TYPE.setDocValueType(DocValues.Type.FIXED_INTS_16); + TYPE.freeze(); + } + + public ShortDocValuesField(String name, short value) { + super(name, TYPE); + fieldsData = Short.valueOf(value); + } +} Index: lucene/core/src/java/org/apache/lucene/document/FloatDocValuesField.java =================================================================== --- lucene/core/src/java/org/apache/lucene/document/FloatDocValuesField.java (revision 0) +++ lucene/core/src/java/org/apache/lucene/document/FloatDocValuesField.java (working copy) @@ -0,0 +1,53 @@ +package org.apache.lucene.document; + +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.util.EnumSet; +import java.util.HashMap; +import java.util.Map; + +import org.apache.lucene.index.DocValues; + +/** + *
+ * This class provides a {@link Field} that enables storing + * of a per-document float value for scoring, sorting or value retrieval. Here's an + * example usage: + * + *
+ * document.add(new FloatDocValuesField(name, 22f)); + *+ * + *
+ * If you also need to store the value, you should add a + * separate {@link StoredField} instance. + * */ + +public class FloatDocValuesField extends Field { + + public static final FieldType TYPE = new FieldType(); + static { + TYPE.setDocValueType(DocValues.Type.FLOAT_32); + TYPE.freeze(); + } + + public FloatDocValuesField(String name, float value) { + super(name, TYPE); + fieldsData = Float.valueOf(value); + } +} Index: lucene/core/src/java/org/apache/lucene/document/SortedBytesDocValuesField.java =================================================================== --- lucene/core/src/java/org/apache/lucene/document/SortedBytesDocValuesField.java (revision 0) +++ lucene/core/src/java/org/apache/lucene/document/SortedBytesDocValuesField.java (working copy) @@ -0,0 +1,61 @@ +package org.apache.lucene.document; + +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import org.apache.lucene.index.DocValues; +import org.apache.lucene.util.BytesRef; + +/** + *
+ * This class provides a {@link Field} that enables storing + * of a per-document {@link BytesRef} value, indexed for + * sorting. Here's an example usage: + * + *
+ * document.add(new SortedBytesDocValuesField(name, new BytesRef("hello")));
+ *
+ *
+ * + * If you also need to store the value, you should add a + * separate {@link StoredField} instance. + * */ + +public class SortedBytesDocValuesField extends Field { + + // TODO: ideally indexer figures out var vs fixed on its own!? + public static final FieldType TYPE_FIXED_LEN = new FieldType(); + static { + TYPE_FIXED_LEN.setDocValueType(DocValues.Type.BYTES_FIXED_SORTED); + TYPE_FIXED_LEN.freeze(); + } + + public static final FieldType TYPE_VAR_LEN = new FieldType(); + static { + TYPE_VAR_LEN.setDocValueType(DocValues.Type.BYTES_VAR_SORTED); + TYPE_VAR_LEN.freeze(); + } + + public SortedBytesDocValuesField(String name, BytesRef bytes) { + this(name, bytes, false); + } + + public SortedBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength) { + super(name, isFixedLength ? TYPE_FIXED_LEN : TYPE_VAR_LEN); + fieldsData = bytes; + } +} Index: lucene/core/src/java/org/apache/lucene/document/DocValuesField.java =================================================================== --- lucene/core/src/java/org/apache/lucene/document/DocValuesField.java (revision 1334974) +++ lucene/core/src/java/org/apache/lucene/document/DocValuesField.java (working copy) @@ -1,131 +0,0 @@ -package org.apache.lucene.document; - -/** - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import java.util.EnumSet; -import java.util.HashMap; -import java.util.Map; - -import org.apache.lucene.index.DocValues.Type; // javadocs -import org.apache.lucene.index.DocValues; -import org.apache.lucene.util.BytesRef; - -/** - *
- * This class provides a {@link Field} that enables storing of typed
- * per-document values for scoring, sorting or value retrieval. Here's an
- * example usage, adding an int value (22):
- *
- *
- * document.add(new DocValuesField(name, 22, DocValues.Type.VAR_INTS)); - *- * - * For optimal performance, re-use the
DocValuesField and
- * {@link Document} instance for more than one document:
- *
- *
- * DocValuesField field = new DocValuesField(name, 0, DocValues.Type.VAR_INTS);
- * Document document = new Document();
- * document.add(field);
- *
- * for(all documents) {
- * ...
- * field.setValue(value)
- * writer.addDocument(document);
- * ...
- * }
- *
- *
- *
- * If you also need to store the value, you should add a
- * separate {@link StoredField} instance.
- * */
-
-public class DocValuesField extends Field {
-
- private static final Map
+ * This class provides a {@link Field} that enables storing
+ * of a per-document {@link BytesRef} value. The values are
+ * stored directly with no sharing, which is a good fit when
+ * the fields don't share (many) values, such as a title
+ * field. If values may be shared it's better to use {@link
+ * DerefBytesDocValuesField}. Here's an example usage:
+ *
+ *
+ * If you also need to store the value, you should add a
+ * separate {@link StoredField} instance.
+ * */
+
+public class StraightBytesDocValuesField extends Field {
+
+ // TODO: ideally indexer figures out var vs fixed on its own!?
+ public static final FieldType TYPE_FIXED_LEN = new FieldType();
+ static {
+ TYPE_FIXED_LEN.setDocValueType(DocValues.Type.BYTES_FIXED_STRAIGHT);
+ TYPE_FIXED_LEN.freeze();
+ }
+
+ public static final FieldType TYPE_VAR_LEN = new FieldType();
+ static {
+ TYPE_VAR_LEN.setDocValueType(DocValues.Type.BYTES_VAR_STRAIGHT);
+ TYPE_VAR_LEN.freeze();
+ }
+
+ public StraightBytesDocValuesField(String name, BytesRef bytes) {
+ super(name, TYPE_VAR_LEN);
+ fieldsData = bytes;
+ }
+
+ public StraightBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength) {
+ super(name, isFixedLength ? TYPE_FIXED_LEN : TYPE_VAR_LEN);
+ fieldsData = bytes;
+ }
+}
Index: lucene/core/src/java/org/apache/lucene/document/DerefBytesDocValuesField.java
===================================================================
--- lucene/core/src/java/org/apache/lucene/document/DerefBytesDocValuesField.java (revision 0)
+++ lucene/core/src/java/org/apache/lucene/document/DerefBytesDocValuesField.java (working copy)
@@ -0,0 +1,70 @@
+package org.apache.lucene.document;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import java.util.EnumSet;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.lucene.index.DocValues;
+import org.apache.lucene.util.BytesRef;
+
+/**
+ *
+ * This class provides a {@link Field} that enables storing
+ * of a per-document {@link BytesRef} value. The values are
+ * stored indirectly, such that many documents sharing the
+ * same value all point to a single copy of the value, which
+ * is a good fit when the fields share values. If values
+ * are (mostly) unique it's better to use {@link
+ * StraightBytesDocValuesField}. Here's an example usage:
+ *
+ *
+ * If you also need to store the value, you should add a
+ * separate {@link StoredField} instance.
+ * */
+
+public class DerefBytesDocValuesField extends Field {
+
+ // TODO: ideally indexer figures out var vs fixed on its own!?
+ public static final FieldType TYPE_FIXED_LEN = new FieldType();
+ static {
+ TYPE_FIXED_LEN.setDocValueType(DocValues.Type.BYTES_FIXED_DEREF);
+ TYPE_FIXED_LEN.freeze();
+ }
+
+ public static final FieldType TYPE_VAR_LEN = new FieldType();
+ static {
+ TYPE_VAR_LEN.setDocValueType(DocValues.Type.BYTES_VAR_DEREF);
+ TYPE_VAR_LEN.freeze();
+ }
+
+ public DerefBytesDocValuesField(String name, BytesRef bytes) {
+ super(name, TYPE_VAR_LEN);
+ fieldsData = bytes;
+ }
+
+ public DerefBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength) {
+ super(name, isFixedLength ? TYPE_FIXED_LEN : TYPE_VAR_LEN);
+ fieldsData = bytes;
+ }
+}
Index: lucene/core/src/java/org/apache/lucene/document/LongDocValuesField.java
===================================================================
--- lucene/core/src/java/org/apache/lucene/document/LongDocValuesField.java (revision 0)
+++ lucene/core/src/java/org/apache/lucene/document/LongDocValuesField.java (working copy)
@@ -0,0 +1,49 @@
+package org.apache.lucene.document;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.apache.lucene.index.DocValues;
+
+/**
+ *
+ * This class provides a {@link Field} that enables storing
+ * of a per-document long value for scoring, sorting or value retrieval. Here's an
+ * example usage:
+ *
+ *
+ * If you also need to store the value, you should add a
+ * separate {@link StoredField} instance.
+ * */
+
+public class LongDocValuesField extends Field {
+
+ public static final FieldType TYPE = new FieldType();
+ static {
+ TYPE.setDocValueType(DocValues.Type.FIXED_INTS_64);
+ TYPE.freeze();
+ }
+
+ public LongDocValuesField(String name, long value) {
+ super(name, TYPE);
+ fieldsData = Long.valueOf(value);
+ }
+}
Index: lucene/core/src/java/org/apache/lucene/document/ByteDocValuesField.java
===================================================================
--- lucene/core/src/java/org/apache/lucene/document/ByteDocValuesField.java (revision 0)
+++ lucene/core/src/java/org/apache/lucene/document/ByteDocValuesField.java (working copy)
@@ -0,0 +1,49 @@
+package org.apache.lucene.document;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.apache.lucene.index.DocValues;
+
+/**
+ *
+ * This class provides a {@link Field} that enables storing
+ * of a per-document byte value for scoring, sorting or value retrieval. Here's an
+ * example usage:
+ *
+ *
+ * If you also need to store the value, you should add a
+ * separate {@link StoredField} instance.
+ * */
+
+public class ByteDocValuesField extends Field {
+
+ public static final FieldType TYPE = new FieldType();
+ static {
+ TYPE.setDocValueType(DocValues.Type.FIXED_INTS_8);
+ TYPE.freeze();
+ }
+
+ public ByteDocValuesField(String name, byte value) {
+ super(name, TYPE);
+ fieldsData = Byte.valueOf(value);
+ }
+}
Index: lucene/core/src/java/org/apache/lucene/document/PackedLongDocValuesField.java
===================================================================
--- lucene/core/src/java/org/apache/lucene/document/PackedLongDocValuesField.java (revision 0)
+++ lucene/core/src/java/org/apache/lucene/document/PackedLongDocValuesField.java (working copy)
@@ -0,0 +1,52 @@
+package org.apache.lucene.document;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.apache.lucene.index.DocValues;
+import org.apache.lucene.index.AtomicReader; // javadocs
+
+/**
+ *
+ * This class provides a {@link Field} that enables storing
+ * of a per-document long value for scoring, sorting or
+ * value retrieval. The values are encoded in the index an
+ * in RAM (when loaded via {@link AtomicReader#docValues})
+ * using packed ints. Here's an example usage:
+ *
+ *
+ * If you also need to store the value, you should add a
+ * separate {@link StoredField} instance.
+ * */
+
+public class PackedLongDocValuesField extends Field {
+
+ public static final FieldType TYPE = new FieldType();
+ static {
+ TYPE.setDocValueType(DocValues.Type.VAR_INTS);
+ TYPE.freeze();
+ }
+
+ public PackedLongDocValuesField(String name, long value) {
+ super(name, TYPE);
+ fieldsData = Long.valueOf(value);
+ }
+}
Index: lucene/grouping/src/test/org/apache/lucene/search/grouping/GroupFacetCollectorTest.java
===================================================================
--- lucene/grouping/src/test/org/apache/lucene/search/grouping/GroupFacetCollectorTest.java (revision 1334974)
+++ lucene/grouping/src/test/org/apache/lucene/search/grouping/GroupFacetCollectorTest.java (working copy)
@@ -220,7 +220,7 @@
private void addField(Document doc, String field, String value, boolean canUseIDV) {
doc.add(new Field(field, value, StringField.TYPE_UNSTORED));
if (canUseIDV) {
- doc.add(new DocValuesField(field, new BytesRef(value), DocValues.Type.BYTES_VAR_SORTED));
+ doc.add(new SortedBytesDocValuesField(field, new BytesRef(value)));
}
}
@@ -368,7 +368,7 @@
Document docNoFacet = new Document();
Document docNoGroupNoFacet = new Document();
Field group = newField("group", "", StringField.TYPE_UNSTORED);
- DocValuesField groupDc = new DocValuesField("group", new BytesRef(), DocValues.Type.BYTES_VAR_SORTED);
+ Field groupDc = new SortedBytesDocValuesField("group", new BytesRef());
if (useDv) {
doc.add(groupDc);
docNoFacet.add(groupDc);
@@ -381,7 +381,7 @@
facetFields[0] = newField("facet", "", StringField.TYPE_UNSTORED);
doc.add(facetFields[0]);
docNoGroup.add(facetFields[0]);
- facetFields[1] = new DocValuesField("facet", new BytesRef(), DocValues.Type.BYTES_VAR_SORTED);
+ facetFields[1] = new SortedBytesDocValuesField("facet", new BytesRef());
doc.add(facetFields[1]);
docNoGroup.add(facetFields[1]);
} else {
Index: lucene/grouping/src/test/org/apache/lucene/search/grouping/DistinctValuesCollectorTest.java
===================================================================
--- lucene/grouping/src/test/org/apache/lucene/search/grouping/DistinctValuesCollectorTest.java (revision 1334974)
+++ lucene/grouping/src/test/org/apache/lucene/search/grouping/DistinctValuesCollectorTest.java (working copy)
@@ -17,6 +17,9 @@
* limitations under the License.
*/
+import java.io.IOException;
+import java.util.*;
+
import org.apache.lucene.analysis.MockAnalyzer;
import org.apache.lucene.document.*;
import org.apache.lucene.index.*;
@@ -37,9 +40,6 @@
import org.apache.lucene.util.mutable.MutableValue;
import org.apache.lucene.util.mutable.MutableValueStr;
-import java.io.IOException;
-import java.util.*;
-
public class DistinctValuesCollectorTest extends AbstractGroupingTestCase {
private final static NullComparator nullComparator = new NullComparator();
@@ -321,17 +321,19 @@
return;
}
- DocValuesField valuesField = null;
+ Field valuesField = null;
switch (type) {
case VAR_INTS:
- valuesField = new DocValuesField(field, Integer.parseInt(value), type);
+ valuesField = new PackedLongDocValuesField(field, Integer.parseInt(value));
break;
case FLOAT_64:
- valuesField = new DocValuesField(field, Double.parseDouble(value), type);
+ valuesField = new DoubleDocValuesField(field, Double.parseDouble(value));
break;
case BYTES_VAR_STRAIGHT:
+ valuesField = new StraightBytesDocValuesField(field, new BytesRef(value));
+ break;
case BYTES_VAR_SORTED:
- valuesField = new DocValuesField(field, new BytesRef(value), type);
+ valuesField = new SortedBytesDocValuesField(field, new BytesRef(value));
break;
}
doc.add(valuesField);
Index: lucene/grouping/src/test/org/apache/lucene/search/grouping/TestGrouping.java
===================================================================
--- lucene/grouping/src/test/org/apache/lucene/search/grouping/TestGrouping.java (revision 1334974)
+++ lucene/grouping/src/test/org/apache/lucene/search/grouping/TestGrouping.java (working copy)
@@ -175,7 +175,7 @@
private void addGroupField(Document doc, String groupField, String value, boolean canUseIDV) {
doc.add(new Field(groupField, value, TextField.TYPE_STORED));
if (canUseIDV) {
- doc.add(new DocValuesField(groupField, new BytesRef(value), Type.BYTES_VAR_SORTED));
+ doc.add(new SortedBytesDocValuesField(groupField, new BytesRef(value)));
}
}
@@ -706,7 +706,7 @@
Document doc = new Document();
Document docNoGroup = new Document();
- DocValuesField idvGroupField = new DocValuesField("group", new BytesRef(), Type.BYTES_VAR_SORTED);
+ Field idvGroupField = new SortedBytesDocValuesField("group", new BytesRef());
if (canUseIDV) {
doc.add(idvGroupField);
}
Index: lucene/grouping/src/test/org/apache/lucene/search/grouping/AllGroupsCollectorTest.java
===================================================================
--- lucene/grouping/src/test/org/apache/lucene/search/grouping/AllGroupsCollectorTest.java (revision 1334974)
+++ lucene/grouping/src/test/org/apache/lucene/search/grouping/AllGroupsCollectorTest.java (working copy)
@@ -123,7 +123,7 @@
private void addGroupField(Document doc, String groupField, String value, boolean canUseIDV) {
doc.add(new Field(groupField, value, TextField.TYPE_STORED));
if (canUseIDV) {
- doc.add(new DocValuesField(groupField, new BytesRef(value), Type.BYTES_VAR_SORTED));
+ doc.add(new SortedBytesDocValuesField(groupField, new BytesRef(value)));
}
}
Index: lucene/grouping/src/test/org/apache/lucene/search/grouping/GroupingSearchTest.java
===================================================================
--- lucene/grouping/src/test/org/apache/lucene/search/grouping/GroupingSearchTest.java (revision 1334974)
+++ lucene/grouping/src/test/org/apache/lucene/search/grouping/GroupingSearchTest.java (working copy)
@@ -168,7 +168,7 @@
private void addGroupField(Document doc, String groupField, String value, boolean canUseIDV) {
doc.add(new Field(groupField, value, TextField.TYPE_STORED));
if (canUseIDV) {
- doc.add(new DocValuesField(groupField, new BytesRef(value), DocValues.Type.BYTES_VAR_SORTED));
+ doc.add(new SortedBytesDocValuesField(groupField, new BytesRef(value)));
}
}
Index: lucene/grouping/src/test/org/apache/lucene/search/grouping/AllGroupHeadsCollectorTest.java
===================================================================
--- lucene/grouping/src/test/org/apache/lucene/search/grouping/AllGroupHeadsCollectorTest.java (revision 1334974)
+++ lucene/grouping/src/test/org/apache/lucene/search/grouping/AllGroupHeadsCollectorTest.java (working copy)
@@ -17,14 +17,17 @@
* limitations under the License.
*/
+import java.io.IOException;
+import java.util.*;
+
import org.apache.lucene.analysis.MockAnalyzer;
import org.apache.lucene.document.*;
import org.apache.lucene.index.DirectoryReader;
+import org.apache.lucene.index.DocValues.Type;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.RandomIndexWriter;
import org.apache.lucene.index.SlowCompositeReaderWrapper;
import org.apache.lucene.index.Term;
-import org.apache.lucene.index.DocValues.Type;
import org.apache.lucene.queries.function.ValueSource;
import org.apache.lucene.queries.function.valuesource.BytesRefFieldSource;
import org.apache.lucene.search.*;
@@ -37,9 +40,6 @@
import org.apache.lucene.util.LuceneTestCase;
import org.apache.lucene.util._TestUtil;
-import java.io.IOException;
-import java.util.*;
-
public class AllGroupHeadsCollectorTest extends LuceneTestCase {
private static final Type[] vts = new Type[]{
@@ -210,9 +210,21 @@
Document docNoGroup = new Document();
Field group = newField("group", "", StringField.TYPE_UNSTORED);
doc.add(group);
- DocValuesField valuesField = null;
+ Field valuesField = null;
if (canUseIDV) {
- valuesField = new DocValuesField("group", new BytesRef(), valueType);
+ switch(valueType) {
+ case BYTES_VAR_DEREF:
+ valuesField = new DerefBytesDocValuesField("group", new BytesRef());
+ break;
+ case BYTES_VAR_STRAIGHT:
+ valuesField = new StraightBytesDocValuesField("group", new BytesRef());
+ break;
+ case BYTES_VAR_SORTED:
+ valuesField = new SortedBytesDocValuesField("group", new BytesRef());
+ break;
+ default:
+ fail("unhandled type");
+ }
doc.add(valuesField);
}
Field sort1 = newField("sort1", "", StringField.TYPE_UNSTORED);
@@ -529,7 +541,21 @@
private void addGroupField(Document doc, String groupField, String value, boolean canUseIDV, Type valueType) {
doc.add(new Field(groupField, value, TextField.TYPE_STORED));
if (canUseIDV) {
- doc.add(new DocValuesField(groupField, new BytesRef(value), valueType));
+ Field valuesField = null;
+ switch(valueType) {
+ case BYTES_VAR_DEREF:
+ valuesField = new DerefBytesDocValuesField(groupField, new BytesRef(value));
+ break;
+ case BYTES_VAR_STRAIGHT:
+ valuesField = new StraightBytesDocValuesField(groupField, new BytesRef(value));
+ break;
+ case BYTES_VAR_SORTED:
+ valuesField = new SortedBytesDocValuesField(groupField, new BytesRef(value));
+ break;
+ default:
+ fail("unhandled type");
+ }
+ doc.add(valuesField);
}
}
Index: lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupingSearch.java
===================================================================
--- lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupingSearch.java (revision 1334974)
+++ lucene/grouping/src/java/org/apache/lucene/search/grouping/GroupingSearch.java (working copy)
@@ -17,7 +17,10 @@
* limitations under the License.
*/
-import org.apache.lucene.document.DocValuesField;
+import java.io.IOException;
+import java.util.*;
+
+import org.apache.lucene.document.DerefBytesDocValuesField;
import org.apache.lucene.index.DocValues;
import org.apache.lucene.queries.function.ValueSource;
import org.apache.lucene.search.*;
@@ -37,9 +40,6 @@
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.mutable.MutableValue;
-import java.io.IOException;
-import java.util.*;
-
/**
* Convenience class to perform grouping in a non distributed environment.
*
@@ -85,7 +85,8 @@
/**
* Constructs a
+ * document.add(new StraightBytesDocValuesField(name, new BytesRef("hello")));
+ *
+ *
+ *
+ * document.add(new DerefBytesDocValuesField(name, new BytesRef("hello")));
+ *
+ *
+ *
+ * document.add(new LongDocValuesField(name, 22L));
+ *
+ *
+ *
+ * document.add(new ByteDocValuesField(name, (byte) 22));
+ *
+ *
+ *
+ * document.add(new PackedLongDocValuesField(name, 22L));
+ *
+ *
+ * GroupingSearch instance that groups documents by doc values.
- * This constructor can only be used when the groupField is a {@link DocValuesField}.
+ * This constructor can only be used when the groupField
+ * is a *DocValuesField (eg, {@link DerefBytesDocValuesField}.
*
* @param groupField The name of the field to group by that contains doc values
* @param docValuesType The doc values type of the specified groupField
Index: lucene/test-framework/src/java/org/apache/lucene/index/RandomIndexWriter.java
===================================================================
--- lucene/test-framework/src/java/org/apache/lucene/index/RandomIndexWriter.java (revision 1334974)
+++ lucene/test-framework/src/java/org/apache/lucene/index/RandomIndexWriter.java (working copy)
@@ -25,9 +25,18 @@
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.MockAnalyzer;
import org.apache.lucene.codecs.Codec;
-import org.apache.lucene.document.DocValuesField;
+import org.apache.lucene.document.ByteDocValuesField;
+import org.apache.lucene.document.DerefBytesDocValuesField;
import org.apache.lucene.document.Document;
+import org.apache.lucene.document.DoubleDocValuesField;
import org.apache.lucene.document.Field;
+import org.apache.lucene.document.FloatDocValuesField;
+import org.apache.lucene.document.IntDocValuesField;
+import org.apache.lucene.document.LongDocValuesField;
+import org.apache.lucene.document.PackedLongDocValuesField;
+import org.apache.lucene.document.ShortDocValuesField;
+import org.apache.lucene.document.SortedBytesDocValuesField;
+import org.apache.lucene.document.StraightBytesDocValuesField;
import org.apache.lucene.index.IndexWriter; // javadoc
import org.apache.lucene.search.Query;
import org.apache.lucene.store.Directory;
@@ -138,7 +147,7 @@
public