You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2015/02/07 08:38:46 UTC
svn commit: r1658029 [4/5] - in /lucene/dev/trunk/lucene:
analysis/common/src/java/org/apache/lucene/analysis/ar/
analysis/common/src/java/org/apache/lucene/analysis/bg/
analysis/common/src/java/org/apache/lucene/analysis/br/
analysis/common/src/java/o...
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,262 +1,258 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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
+/*
+ * 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.
+ */
- 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.
--->
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-</head>
-<body>
-Code to maintain and access indices.
-<!-- TODO: add IndexWriter, IndexWriterConfig, DocValues, etc etc -->
-<h2>Table Of Contents</h2>
-<p>
- <ol>
- <li><a href="#postings">Postings APIs</a>
- <ul>
- <li><a href="#fields">Fields</a></li>
- <li><a href="#terms">Terms</a></li>
- <li><a href="#documents">Documents</a></li>
- <li><a href="#positions">Positions</a></li>
- </ul>
- </li>
- <li><a href="#stats">Index Statistics</a>
- <ul>
- <li><a href="#termstats">Term-level</a></li>
- <li><a href="#fieldstats">Field-level</a></li>
- <li><a href="#segmentstats">Segment-level</a></li>
- <li><a href="#documentstats">Document-level</a></li>
- </ul>
- </li>
- </ol>
-</p>
-<a name="postings"></a>
-<h2>Postings APIs</h2>
-<a name="fields"></a>
-<h4>
- Fields
-</h4>
-<p>
-{@link org.apache.lucene.index.Fields} is the initial entry point into the
-postings APIs, this can be obtained in several ways:
-<pre class="prettyprint">
-// access indexed fields for an index segment
-Fields fields = reader.fields();
-// access term vector fields for a specified document
-Fields fields = reader.getTermVectors(docid);
-</pre>
-Fields implements Java's Iterable interface, so it's easy to enumerate the
-list of fields:
-<pre class="prettyprint">
-// enumerate list of fields
-for (String field : fields) {
- // access the terms for this field
- Terms terms = fields.terms(field);
-}
-</pre>
-</p>
-<a name="terms"></a>
-<h4>
- Terms
-</h4>
-<p>
-{@link org.apache.lucene.index.Terms} represents the collection of terms
-within a field, exposes some metadata and <a href="#fieldstats">statistics</a>,
-and an API for enumeration.
-<pre class="prettyprint">
-// metadata about the field
-System.out.println("positions? " + terms.hasPositions());
-System.out.println("offsets? " + terms.hasOffsets());
-System.out.println("payloads? " + terms.hasPayloads());
-// iterate through terms
-TermsEnum termsEnum = terms.iterator(null);
-BytesRef term = null;
-while ((term = termsEnum.next()) != null) {
- doSomethingWith(termsEnum.term());
-}
-</pre>
-{@link org.apache.lucene.index.TermsEnum} provides an iterator over the list
-of terms within a field, some <a href="#termstats">statistics</a> about the term,
-and methods to access the term's <a href="#documents">documents</a> and
-<a href="#positions">positions</a>.
-<pre class="prettyprint">
-// seek to a specific term
-boolean found = termsEnum.seekExact(new BytesRef("foobar"));
-if (found) {
- // get the document frequency
- System.out.println(termsEnum.docFreq());
- // enumerate through documents
- DocsEnum docs = termsEnum.docs(null, null);
- // enumerate through documents and positions
- DocsAndPositionsEnum docsAndPositions = termsEnum.docsAndPositions(null, null);
-}
-</pre>
-</p>
-<a name="documents"></a>
-<h4>
- Documents
-</h4>
-<p>
- {@link org.apache.lucene.index.PostingsEnum} is an extension of
- {@link org.apache.lucene.search.DocIdSetIterator}that iterates over the list of
- documents for a term, along with the term frequency within that document.
-<pre class="prettyprint">
-int docid;
-while ((docid = docsEnum.nextDoc()) != DocIdSetIterator.NO_MORE_DOCS) {
- System.out.println(docid);
- System.out.println(docsEnum.freq());
-}
-</pre>
-</p>
-<a name="positions"></a>
-<h4>
- Positions
-</h4>
-<p>
- PostingsEnum also allows iteration
- of the positions a term occurred within the document, and any additional
- per-position information (offsets and payload). The information available
- is controlled by flags passed to TermsEnum#postings
-<pre class="prettyprint">
-int docid;
-PostingsEnum postings = termsEnum.postings(null, null, PostingsEnum.FLAG_PAYLOADS | PostingsEnum.FLAG_OFFSETS);
-while ((docid = postings.nextDoc()) != DocIdSetIterator.NO_MORE_DOCS) {
- System.out.println(docid);
- int freq = postings.freq();
- for (int i = 0; i < freq; i++) {
- System.out.println(postings.nextPosition());
- System.out.println(postings.startOffset());
- System.out.println(postings.endOffset());
- System.out.println(postings.getPayload());
- }
-}
-</pre>
-</p>
-<a name="stats"></a>
-<h2>Index Statistics</h2>
-<a name="termstats"></a>
-<h4>
- Term statistics
-</h4>
-<p>
- <ul>
- <li>{@link org.apache.lucene.index.TermsEnum#docFreq}: Returns the number of
- documents that contain at least one occurrence of the term. This statistic
- is always available for an indexed term. Note that it will also count
- deleted documents, when segments are merged the statistic is updated as
- those deleted documents are merged away.
- <li>{@link org.apache.lucene.index.TermsEnum#totalTermFreq}: Returns the number
- of occurrences of this term across all documents. Note that this statistic
- is unavailable (returns <code>-1</code>) if term frequencies were omitted
- from the index
- ({@link org.apache.lucene.index.IndexOptions#DOCS DOCS})
- for the field. Like docFreq(), it will also count occurrences that appear in
- deleted documents.
- </ul>
-</p>
-<a name="fieldstats"></a>
-<h4>
- Field statistics
-</h4>
-<p>
- <ul>
- <li>{@link org.apache.lucene.index.Terms#size}: Returns the number of
- unique terms in the field. This statistic may be unavailable
- (returns <code>-1</code>) for some Terms implementations such as
- {@link org.apache.lucene.index.MultiTerms}, where it cannot be efficiently
- computed. Note that this count also includes terms that appear only
- in deleted documents: when segments are merged such terms are also merged
- away and the statistic is then updated.
- <li>{@link org.apache.lucene.index.Terms#getDocCount}: Returns the number of
- documents that contain at least one occurrence of any term for this field.
- This can be thought of as a Field-level docFreq(). Like docFreq() it will
- also count deleted documents.
- <li>{@link org.apache.lucene.index.Terms#getSumDocFreq}: Returns the number of
- postings (term-document mappings in the inverted index) for the field. This
- can be thought of as the sum of {@link org.apache.lucene.index.TermsEnum#docFreq}
- across all terms in the field, and like docFreq() it will also count postings
- that appear in deleted documents.
- <li>{@link org.apache.lucene.index.Terms#getSumTotalTermFreq}: Returns the number
- of tokens for the field. This can be thought of as the sum of
- {@link org.apache.lucene.index.TermsEnum#totalTermFreq} across all terms in the
- field, and like totalTermFreq() it will also count occurrences that appear in
- deleted documents, and will be unavailable (returns <code>-1</code>) if term
- frequencies were omitted from the index
- ({@link org.apache.lucene.index.IndexOptions#DOCS DOCS})
- for the field.
- </ul>
-</p>
-<a name="segmentstats"></a>
-<h4>
- Segment statistics
-</h4>
-<p>
- <ul>
- <li>{@link org.apache.lucene.index.IndexReader#maxDoc}: Returns the number of
- documents (including deleted documents) in the index.
- <li>{@link org.apache.lucene.index.IndexReader#numDocs}: Returns the number
- of live documents (excluding deleted documents) in the index.
- <li>{@link org.apache.lucene.index.IndexReader#numDeletedDocs}: Returns the
- number of deleted documents in the index.
- <li>{@link org.apache.lucene.index.Fields#size}: Returns the number of indexed
- fields.
- </ul>
-</p>
-<a name="documentstats"></a>
-<h4>
- Document statistics
-</h4>
-<p>
-Document statistics are available during the indexing process for an indexed field: typically
-a {@link org.apache.lucene.search.similarities.Similarity} implementation will store some
-of these values (possibly in a lossy way), into the normalization value for the document in
-its {@link org.apache.lucene.search.similarities.Similarity#computeNorm} method.
-</p>
-<p>
- <ul>
- <li>{@link org.apache.lucene.index.FieldInvertState#getLength}: Returns the number of
- tokens for this field in the document. Note that this is just the number
- of times that {@link org.apache.lucene.analysis.TokenStream#incrementToken} returned
- true, and is unrelated to the values in
- {@link org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute}.
- <li>{@link org.apache.lucene.index.FieldInvertState#getNumOverlap}: Returns the number
- of tokens for this field in the document that had a position increment of zero. This
- can be used to compute a document length that discounts artificial tokens
- such as synonyms.
- <li>{@link org.apache.lucene.index.FieldInvertState#getPosition}: Returns the accumulated
- position value for this field in the document: computed from the values of
- {@link org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute} and including
- {@link org.apache.lucene.analysis.Analyzer#getPositionIncrementGap}s across multivalued
- fields.
- <li>{@link org.apache.lucene.index.FieldInvertState#getOffset}: Returns the total
- character offset value for this field in the document: computed from the values of
- {@link org.apache.lucene.analysis.tokenattributes.OffsetAttribute} returned by
- {@link org.apache.lucene.analysis.TokenStream#end}, and including
- {@link org.apache.lucene.analysis.Analyzer#getOffsetGap}s across multivalued
- fields.
- <li>{@link org.apache.lucene.index.FieldInvertState#getUniqueTermCount}: Returns the number
- of unique terms encountered for this field in the document.
- <li>{@link org.apache.lucene.index.FieldInvertState#getMaxTermFrequency}: Returns the maximum
- frequency across all unique terms encountered for this field in the document.
- </ul>
-</p>
-<p>
-Additional user-supplied statistics can be added to the document as DocValues fields and
-accessed via {@link org.apache.lucene.index.LeafReader#getNumericDocValues}.
-</p>
-<p>
-</body>
-</html>
+/**
+ * Code to maintain and access indices.
+ * <!-- TODO: add IndexWriter, IndexWriterConfig, DocValues, etc etc -->
+ * <h2>Table Of Contents</h2>
+ * <p>
+ * <ol>
+ * <li><a href="#postings">Postings APIs</a>
+ * <ul>
+ * <li><a href="#fields">Fields</a></li>
+ * <li><a href="#terms">Terms</a></li>
+ * <li><a href="#documents">Documents</a></li>
+ * <li><a href="#positions">Positions</a></li>
+ * </ul>
+ * </li>
+ * <li><a href="#stats">Index Statistics</a>
+ * <ul>
+ * <li><a href="#termstats">Term-level</a></li>
+ * <li><a href="#fieldstats">Field-level</a></li>
+ * <li><a href="#segmentstats">Segment-level</a></li>
+ * <li><a href="#documentstats">Document-level</a></li>
+ * </ul>
+ * </li>
+ * </ol>
+ * </p>
+ * <a name="postings"></a>
+ * <h2>Postings APIs</h2>
+ * <a name="fields"></a>
+ * <h3>
+ * Fields
+ * </h3>
+ * <p>
+ * {@link org.apache.lucene.index.Fields} is the initial entry point into the
+ * postings APIs, this can be obtained in several ways:
+ * <pre class="prettyprint">
+ * // access indexed fields for an index segment
+ * Fields fields = reader.fields();
+ * // access term vector fields for a specified document
+ * Fields fields = reader.getTermVectors(docid);
+ * </pre>
+ * Fields implements Java's Iterable interface, so it's easy to enumerate the
+ * list of fields:
+ * <pre class="prettyprint">
+ * // enumerate list of fields
+ * for (String field : fields) {
+ * // access the terms for this field
+ * Terms terms = fields.terms(field);
+ * }
+ * </pre>
+ * </p>
+ * <a name="terms"></a>
+ * <h3>
+ * Terms
+ * </h3>
+ * <p>
+ * {@link org.apache.lucene.index.Terms} represents the collection of terms
+ * within a field, exposes some metadata and <a href="#fieldstats">statistics</a>,
+ * and an API for enumeration.
+ * <pre class="prettyprint">
+ * // metadata about the field
+ * System.out.println("positions? " + terms.hasPositions());
+ * System.out.println("offsets? " + terms.hasOffsets());
+ * System.out.println("payloads? " + terms.hasPayloads());
+ * // iterate through terms
+ * TermsEnum termsEnum = terms.iterator(null);
+ * BytesRef term = null;
+ * while ((term = termsEnum.next()) != null) {
+ * doSomethingWith(termsEnum.term());
+ * }
+ * </pre>
+ * {@link org.apache.lucene.index.TermsEnum} provides an iterator over the list
+ * of terms within a field, some <a href="#termstats">statistics</a> about the term,
+ * and methods to access the term's <a href="#documents">documents</a> and
+ * <a href="#positions">positions</a>.
+ * <pre class="prettyprint">
+ * // seek to a specific term
+ * boolean found = termsEnum.seekExact(new BytesRef("foobar"));
+ * if (found) {
+ * // get the document frequency
+ * System.out.println(termsEnum.docFreq());
+ * // enumerate through documents
+ * DocsEnum docs = termsEnum.docs(null, null);
+ * // enumerate through documents and positions
+ * DocsAndPositionsEnum docsAndPositions = termsEnum.docsAndPositions(null, null);
+ * }
+ * </pre>
+ * </p>
+ * <a name="documents"></a>
+ * <h3>
+ * Documents
+ * </h3>
+ * <p>
+ * {@link org.apache.lucene.index.PostingsEnum} is an extension of
+ * {@link org.apache.lucene.search.DocIdSetIterator}that iterates over the list of
+ * documents for a term, along with the term frequency within that document.
+ * <pre class="prettyprint">
+ * int docid;
+ * while ((docid = docsEnum.nextDoc()) != DocIdSetIterator.NO_MORE_DOCS) {
+ * System.out.println(docid);
+ * System.out.println(docsEnum.freq());
+ * }
+ * </pre>
+ * </p>
+ * <a name="positions"></a>
+ * <h3>
+ * Positions
+ * </h3>
+ * <p>
+ * PostingsEnum also allows iteration
+ * of the positions a term occurred within the document, and any additional
+ * per-position information (offsets and payload). The information available
+ * is controlled by flags passed to TermsEnum#postings
+ * <pre class="prettyprint">
+ * int docid;
+ * PostingsEnum postings = termsEnum.postings(null, null, PostingsEnum.FLAG_PAYLOADS | PostingsEnum.FLAG_OFFSETS);
+ * while ((docid = postings.nextDoc()) != DocIdSetIterator.NO_MORE_DOCS) {
+ * System.out.println(docid);
+ * int freq = postings.freq();
+ * for (int i = 0; i < freq; i++) {
+ * System.out.println(postings.nextPosition());
+ * System.out.println(postings.startOffset());
+ * System.out.println(postings.endOffset());
+ * System.out.println(postings.getPayload());
+ * }
+ * }
+ * </pre>
+ * </p>
+ * <a name="stats"></a>
+ * <h2>Index Statistics</h2>
+ * <a name="termstats"></a>
+ * <h3>
+ * Term statistics
+ * </h3>
+ * <p>
+ * <ul>
+ * <li>{@link org.apache.lucene.index.TermsEnum#docFreq}: Returns the number of
+ * documents that contain at least one occurrence of the term. This statistic
+ * is always available for an indexed term. Note that it will also count
+ * deleted documents, when segments are merged the statistic is updated as
+ * those deleted documents are merged away.
+ * <li>{@link org.apache.lucene.index.TermsEnum#totalTermFreq}: Returns the number
+ * of occurrences of this term across all documents. Note that this statistic
+ * is unavailable (returns <code>-1</code>) if term frequencies were omitted
+ * from the index
+ * ({@link org.apache.lucene.index.IndexOptions#DOCS DOCS})
+ * for the field. Like docFreq(), it will also count occurrences that appear in
+ * deleted documents.
+ * </ul>
+ * </p>
+ * <a name="fieldstats"></a>
+ * <h3>
+ * Field statistics
+ * </h3>
+ * <p>
+ * <ul>
+ * <li>{@link org.apache.lucene.index.Terms#size}: Returns the number of
+ * unique terms in the field. This statistic may be unavailable
+ * (returns <code>-1</code>) for some Terms implementations such as
+ * {@link org.apache.lucene.index.MultiTerms}, where it cannot be efficiently
+ * computed. Note that this count also includes terms that appear only
+ * in deleted documents: when segments are merged such terms are also merged
+ * away and the statistic is then updated.
+ * <li>{@link org.apache.lucene.index.Terms#getDocCount}: Returns the number of
+ * documents that contain at least one occurrence of any term for this field.
+ * This can be thought of as a Field-level docFreq(). Like docFreq() it will
+ * also count deleted documents.
+ * <li>{@link org.apache.lucene.index.Terms#getSumDocFreq}: Returns the number of
+ * postings (term-document mappings in the inverted index) for the field. This
+ * can be thought of as the sum of {@link org.apache.lucene.index.TermsEnum#docFreq}
+ * across all terms in the field, and like docFreq() it will also count postings
+ * that appear in deleted documents.
+ * <li>{@link org.apache.lucene.index.Terms#getSumTotalTermFreq}: Returns the number
+ * of tokens for the field. This can be thought of as the sum of
+ * {@link org.apache.lucene.index.TermsEnum#totalTermFreq} across all terms in the
+ * field, and like totalTermFreq() it will also count occurrences that appear in
+ * deleted documents, and will be unavailable (returns <code>-1</code>) if term
+ * frequencies were omitted from the index
+ * ({@link org.apache.lucene.index.IndexOptions#DOCS DOCS})
+ * for the field.
+ * </ul>
+ * </p>
+ * <a name="segmentstats"></a>
+ * <h3>
+ * Segment statistics
+ * </h3>
+ * <p>
+ * <ul>
+ * <li>{@link org.apache.lucene.index.IndexReader#maxDoc}: Returns the number of
+ * documents (including deleted documents) in the index.
+ * <li>{@link org.apache.lucene.index.IndexReader#numDocs}: Returns the number
+ * of live documents (excluding deleted documents) in the index.
+ * <li>{@link org.apache.lucene.index.IndexReader#numDeletedDocs}: Returns the
+ * number of deleted documents in the index.
+ * <li>{@link org.apache.lucene.index.Fields#size}: Returns the number of indexed
+ * fields.
+ * </ul>
+ * </p>
+ * <a name="documentstats"></a>
+ * <h3>
+ * Document statistics
+ * </h3>
+ * <p>
+ * Document statistics are available during the indexing process for an indexed field: typically
+ * a {@link org.apache.lucene.search.similarities.Similarity} implementation will store some
+ * of these values (possibly in a lossy way), into the normalization value for the document in
+ * its {@link org.apache.lucene.search.similarities.Similarity#computeNorm} method.
+ * </p>
+ * <p>
+ * <ul>
+ * <li>{@link org.apache.lucene.index.FieldInvertState#getLength}: Returns the number of
+ * tokens for this field in the document. Note that this is just the number
+ * of times that {@link org.apache.lucene.analysis.TokenStream#incrementToken} returned
+ * true, and is unrelated to the values in
+ * {@link org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute}.
+ * <li>{@link org.apache.lucene.index.FieldInvertState#getNumOverlap}: Returns the number
+ * of tokens for this field in the document that had a position increment of zero. This
+ * can be used to compute a document length that discounts artificial tokens
+ * such as synonyms.
+ * <li>{@link org.apache.lucene.index.FieldInvertState#getPosition}: Returns the accumulated
+ * position value for this field in the document: computed from the values of
+ * {@link org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute} and including
+ * {@link org.apache.lucene.analysis.Analyzer#getPositionIncrementGap}s across multivalued
+ * fields.
+ * <li>{@link org.apache.lucene.index.FieldInvertState#getOffset}: Returns the total
+ * character offset value for this field in the document: computed from the values of
+ * {@link org.apache.lucene.analysis.tokenattributes.OffsetAttribute} returned by
+ * {@link org.apache.lucene.analysis.TokenStream#end}, and including
+ * {@link org.apache.lucene.analysis.Analyzer#getOffsetGap}s across multivalued
+ * fields.
+ * <li>{@link org.apache.lucene.index.FieldInvertState#getUniqueTermCount}: Returns the number
+ * of unique terms encountered for this field in the document.
+ * <li>{@link org.apache.lucene.index.FieldInvertState#getMaxTermFrequency}: Returns the maximum
+ * frequency across all unique terms encountered for this field in the document.
+ * </ul>
+ * </p>
+ * <p>
+ * Additional user-supplied statistics can be added to the document as DocValues fields and
+ * accessed via {@link org.apache.lucene.index.LeafReader#getNumericDocValues}.
+ * </p>
+ * <p>
+ */
+package org.apache.lucene.index;
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,17 +1,21 @@
-<!--
- 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.
--->
-<html><body>Top-level package.</body></html>
+/*
+ * 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.
+ */
+
+/**
+ * Top-level package.
+ */
+package org.apache.lucene;
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,32 +1,29 @@
-<HTML>
-<!--
- 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
+/*
+ * 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.
+ */
- 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.
--->
-<HEAD>
- <TITLE>org.apache.lucene.search.payloads</TITLE>
-</HEAD>
-<BODY>
-The payloads package provides Query mechanisms for finding and using payloads.
-<p>
- The following Query implementations are provided:
- <ol>
- <li>{@link org.apache.lucene.search.payloads.PayloadTermQuery PayloadTermQuery} -- Boost a term's score based on the value of the payload located at that term.</li>
- <li>{@link org.apache.lucene.search.payloads.PayloadNearQuery PayloadNearQuery} -- A {@link org.apache.lucene.search.spans.SpanNearQuery SpanNearQuery} that factors in the value of the payloads located
- at each of the positions where the spans occur.</li>
- </ol>
-</p>
-</BODY>
-</HTML>
+/**
+ * The payloads package provides Query mechanisms for finding and using payloads.
+ * <p>
+ * The following Query implementations are provided:
+ * <ol>
+ * <li>{@link org.apache.lucene.search.payloads.PayloadTermQuery PayloadTermQuery} -- Boost a term's score based on the value of the payload located at that term.</li>
+ * <li>{@link org.apache.lucene.search.payloads.PayloadNearQuery PayloadNearQuery} -- A {@link org.apache.lucene.search.spans.SpanNearQuery SpanNearQuery} that factors in the value of the payloads located
+ * at each of the positions where the spans occur.</li>
+ * </ol>
+ * </p>
+ */
+package org.apache.lucene.search.payloads;
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,151 +1,146 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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.
--->
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-</head>
-<body>
-This package contains the various ranking models that can be used in Lucene. The
-abstract class {@link org.apache.lucene.search.similarities.Similarity} serves
-as the base for ranking functions. For searching, users can employ the models
-already implemented or create their own by extending one of the classes in this
-package.
-
-<h2>Table Of Contents</h2>
-<p>
- <ol>
- <li><a href="#sims">Summary of the Ranking Methods</a></li>
- <li><a href="#changingSimilarity">Changing the Similarity</a></li>
- </ol>
-</p>
-
-
-<a name="sims"></a>
-<h2>Summary of the Ranking Methods</h2>
-
-<p>{@link org.apache.lucene.search.similarities.DefaultSimilarity} is the original Lucene
-scoring function. It is based on a highly optimized
-<a href="http://en.wikipedia.org/wiki/Vector_Space_Model">Vector Space Model</a>. For more
-information, see {@link org.apache.lucene.search.similarities.TFIDFSimilarity}.</p>
-
-<p>{@link org.apache.lucene.search.similarities.BM25Similarity} is an optimized
-implementation of the successful Okapi BM25 model.</p>
-
-<p>{@link org.apache.lucene.search.similarities.SimilarityBase} provides a basic
-implementation of the Similarity contract and exposes a highly simplified
-interface, which makes it an ideal starting point for new ranking functions.
-Lucene ships the following methods built on
-{@link org.apache.lucene.search.similarities.SimilarityBase}:
-
-<a name="framework"></a>
-<ul>
- <li>Amati and Rijsbergen's {@linkplain org.apache.lucene.search.similarities.DFRSimilarity DFR} framework;</li>
- <li>Clinchant and Gaussier's {@linkplain org.apache.lucene.search.similarities.IBSimilarity Information-based models}
- for IR;</li>
- <li>The implementation of two {@linkplain org.apache.lucene.search.similarities.LMSimilarity language models} from
- Zhai and Lafferty's paper.</li>
-</ul>
-
-Since {@link org.apache.lucene.search.similarities.SimilarityBase} is not
-optimized to the same extent as
-{@link org.apache.lucene.search.similarities.DefaultSimilarity} and
-{@link org.apache.lucene.search.similarities.BM25Similarity}, a difference in
-performance is to be expected when using the methods listed above. However,
-optimizations can always be implemented in subclasses; see
-<a href="#changingSimilarity">below</a>.</p>
-
-<a name="changingSimilarity"></a>
-<h2>Changing Similarity</h2>
-
-<p>Chances are the available Similarities are sufficient for all
- your searching needs.
- However, in some applications it may be necessary to customize your <a
- href="Similarity.html">Similarity</a> implementation. For instance, some
- applications do not need to
- distinguish between shorter and longer documents (see <a
- href="http://www.gossamer-threads.com/lists/lucene/java-user/38967#38967">a "fair" similarity</a>).</p>
-
-<p>To change {@link org.apache.lucene.search.similarities.Similarity}, one must do so for both indexing and
- searching, and the changes must happen before
- either of these actions take place. Although in theory there is nothing stopping you from changing mid-stream, it
- just isn't well-defined what is going to happen.
-</p>
-
-<p>To make this change, implement your own {@link org.apache.lucene.search.similarities.Similarity} (likely
- you'll want to simply subclass an existing method, be it
- {@link org.apache.lucene.search.similarities.DefaultSimilarity} or a descendant of
- {@link org.apache.lucene.search.similarities.SimilarityBase}), and
- then register the new class by calling
- {@link org.apache.lucene.index.IndexWriterConfig#setSimilarity(Similarity)}
- before indexing and
- {@link org.apache.lucene.search.IndexSearcher#setSimilarity(Similarity)}
- before searching.
-</p>
-
-<h3>Extending {@linkplain org.apache.lucene.search.similarities.SimilarityBase}</h3>
-<p>
-The easiest way to quickly implement a new ranking method is to extend
-{@link org.apache.lucene.search.similarities.SimilarityBase}, which provides
-basic implementations for the low level . Subclasses are only required to
-implement the {@link org.apache.lucene.search.similarities.SimilarityBase#score(BasicStats, float, float)}
-and {@link org.apache.lucene.search.similarities.SimilarityBase#toString()}
-methods.</p>
-
-<p>Another option is to extend one of the <a href="#framework">frameworks</a>
-based on {@link org.apache.lucene.search.similarities.SimilarityBase}. These
-Similarities are implemented modularly, e.g.
-{@link org.apache.lucene.search.similarities.DFRSimilarity} delegates
-computation of the three parts of its formula to the classes
-{@link org.apache.lucene.search.similarities.BasicModel},
-{@link org.apache.lucene.search.similarities.AfterEffect} and
-{@link org.apache.lucene.search.similarities.Normalization}. Instead of
-subclassing the Similarity, one can simply introduce a new basic model and tell
-{@link org.apache.lucene.search.similarities.DFRSimilarity} to use it.</p>
-
-<h3>Changing {@linkplain org.apache.lucene.search.similarities.DefaultSimilarity}</h3>
-<p>
- If you are interested in use cases for changing your similarity, see the Lucene users's mailing list at <a
- href="http://www.gossamer-threads.com/lists/lucene/java-user/39125">Overriding Similarity</a>.
- In summary, here are a few use cases:
- <ol>
- <li><p>The <code>SweetSpotSimilarity</code> in
- <code>org.apache.lucene.misc</code> gives small
- increases as the frequency increases a small amount
- and then greater increases when you hit the "sweet spot", i.e. where
- you think the frequency of terms is more significant.</p></li>
- <li><p>Overriding tf — In some applications, it doesn't matter what the score of a document is as long as a
- matching term occurs. In these
- cases people have overridden Similarity to return 1 from the tf() method.</p></li>
- <li><p>Changing Length Normalization — By overriding
- {@link org.apache.lucene.search.similarities.Similarity#computeNorm(FieldInvertState state)},
- it is possible to discount how the length of a field contributes
- to a score. In {@link org.apache.lucene.search.similarities.DefaultSimilarity},
- lengthNorm = 1 / (numTerms in field)^0.5, but if one changes this to be
- 1 / (numTerms in field), all fields will be treated
- <a href="http://www.gossamer-threads.com/lists/lucene/java-user/38967#38967">"fairly"</a>.</p></li>
- </ol>
- In general, Chris Hostetter sums it up best in saying (from <a
- href="http://www.gossamer-threads.com/lists/lucene/java-user/39125#39125">the Lucene users's mailing list</a>):
- <blockquote>[One would override the Similarity in] ... any situation where you know more about your data then just
- that
- it's "text" is a situation where it *might* make sense to to override your
- Similarity method.</blockquote>
-</p>
-
-</body>
-</html>
+/*
+ * 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.
+ */
+
+/**
+ * This package contains the various ranking models that can be used in Lucene. The
+ * abstract class {@link org.apache.lucene.search.similarities.Similarity} serves
+ * as the base for ranking functions. For searching, users can employ the models
+ * already implemented or create their own by extending one of the classes in this
+ * package.
+ *
+ * <h2>Table Of Contents</h2>
+ * <p>
+ * <ol>
+ * <li><a href="#sims">Summary of the Ranking Methods</a></li>
+ * <li><a href="#changingSimilarity">Changing the Similarity</a></li>
+ * </ol>
+ * </p>
+ *
+ *
+ * <a name="sims"></a>
+ * <h2>Summary of the Ranking Methods</h2>
+ *
+ * <p>{@link org.apache.lucene.search.similarities.DefaultSimilarity} is the original Lucene
+ * scoring function. It is based on a highly optimized
+ * <a href="http://en.wikipedia.org/wiki/Vector_Space_Model">Vector Space Model</a>. For more
+ * information, see {@link org.apache.lucene.search.similarities.TFIDFSimilarity}.</p>
+ *
+ * <p>{@link org.apache.lucene.search.similarities.BM25Similarity} is an optimized
+ * implementation of the successful Okapi BM25 model.</p>
+ *
+ * <p>{@link org.apache.lucene.search.similarities.SimilarityBase} provides a basic
+ * implementation of the Similarity contract and exposes a highly simplified
+ * interface, which makes it an ideal starting point for new ranking functions.
+ * Lucene ships the following methods built on
+ * {@link org.apache.lucene.search.similarities.SimilarityBase}:
+ *
+ * <a name="framework"></a>
+ * <ul>
+ * <li>Amati and Rijsbergen's {@linkplain org.apache.lucene.search.similarities.DFRSimilarity DFR} framework;</li>
+ * <li>Clinchant and Gaussier's {@linkplain org.apache.lucene.search.similarities.IBSimilarity Information-based models}
+ * for IR;</li>
+ * <li>The implementation of two {@linkplain org.apache.lucene.search.similarities.LMSimilarity language models} from
+ * Zhai and Lafferty's paper.</li>
+ * </ul>
+ *
+ * Since {@link org.apache.lucene.search.similarities.SimilarityBase} is not
+ * optimized to the same extent as
+ * {@link org.apache.lucene.search.similarities.DefaultSimilarity} and
+ * {@link org.apache.lucene.search.similarities.BM25Similarity}, a difference in
+ * performance is to be expected when using the methods listed above. However,
+ * optimizations can always be implemented in subclasses; see
+ * <a href="#changingSimilarity">below</a>.</p>
+ *
+ * <a name="changingSimilarity"></a>
+ * <h2>Changing Similarity</h2>
+ *
+ * <p>Chances are the available Similarities are sufficient for all
+ * your searching needs.
+ * However, in some applications it may be necessary to customize your <a
+ * href="Similarity.html">Similarity</a> implementation. For instance, some
+ * applications do not need to
+ * distinguish between shorter and longer documents (see <a
+ * href="http://www.gossamer-threads.com/lists/lucene/java-user/38967#38967">a "fair" similarity</a>).</p>
+ *
+ * <p>To change {@link org.apache.lucene.search.similarities.Similarity}, one must do so for both indexing and
+ * searching, and the changes must happen before
+ * either of these actions take place. Although in theory there is nothing stopping you from changing mid-stream, it
+ * just isn't well-defined what is going to happen.
+ * </p>
+ *
+ * <p>To make this change, implement your own {@link org.apache.lucene.search.similarities.Similarity} (likely
+ * you'll want to simply subclass an existing method, be it
+ * {@link org.apache.lucene.search.similarities.DefaultSimilarity} or a descendant of
+ * {@link org.apache.lucene.search.similarities.SimilarityBase}), and
+ * then register the new class by calling
+ * {@link org.apache.lucene.index.IndexWriterConfig#setSimilarity(Similarity)}
+ * before indexing and
+ * {@link org.apache.lucene.search.IndexSearcher#setSimilarity(Similarity)}
+ * before searching.
+ * </p>
+ *
+ * <h3>Extending {@linkplain org.apache.lucene.search.similarities.SimilarityBase}</h3>
+ * <p>
+ * The easiest way to quickly implement a new ranking method is to extend
+ * {@link org.apache.lucene.search.similarities.SimilarityBase}, which provides
+ * basic implementations for the low level . Subclasses are only required to
+ * implement the {@link org.apache.lucene.search.similarities.SimilarityBase#score(BasicStats, float, float)}
+ * and {@link org.apache.lucene.search.similarities.SimilarityBase#toString()}
+ * methods.</p>
+ *
+ * <p>Another option is to extend one of the <a href="#framework">frameworks</a>
+ * based on {@link org.apache.lucene.search.similarities.SimilarityBase}. These
+ * Similarities are implemented modularly, e.g.
+ * {@link org.apache.lucene.search.similarities.DFRSimilarity} delegates
+ * computation of the three parts of its formula to the classes
+ * {@link org.apache.lucene.search.similarities.BasicModel},
+ * {@link org.apache.lucene.search.similarities.AfterEffect} and
+ * {@link org.apache.lucene.search.similarities.Normalization}. Instead of
+ * subclassing the Similarity, one can simply introduce a new basic model and tell
+ * {@link org.apache.lucene.search.similarities.DFRSimilarity} to use it.</p>
+ *
+ * <h3>Changing {@linkplain org.apache.lucene.search.similarities.DefaultSimilarity}</h3>
+ * <p>
+ * If you are interested in use cases for changing your similarity, see the Lucene users's mailing list at <a
+ * href="http://www.gossamer-threads.com/lists/lucene/java-user/39125">Overriding Similarity</a>.
+ * In summary, here are a few use cases:
+ * <ol>
+ * <li><p>The <code>SweetSpotSimilarity</code> in
+ * <code>org.apache.lucene.misc</code> gives small
+ * increases as the frequency increases a small amount
+ * and then greater increases when you hit the "sweet spot", i.e. where
+ * you think the frequency of terms is more significant.</p></li>
+ * <li><p>Overriding tf — In some applications, it doesn't matter what the score of a document is as long as a
+ * matching term occurs. In these
+ * cases people have overridden Similarity to return 1 from the tf() method.</p></li>
+ * <li><p>Changing Length Normalization — By overriding
+ * {@link org.apache.lucene.search.similarities.Similarity#computeNorm(org.apache.lucene.index.FieldInvertState state)},
+ * it is possible to discount how the length of a field contributes
+ * to a score. In {@link org.apache.lucene.search.similarities.DefaultSimilarity},
+ * lengthNorm = 1 / (numTerms in field)^0.5, but if one changes this to be
+ * 1 / (numTerms in field), all fields will be treated
+ * <a href="http://www.gossamer-threads.com/lists/lucene/java-user/38967#38967">"fairly"</a>.</p></li>
+ * </ol>
+ * In general, Chris Hostetter sums it up best in saying (from <a
+ * href="http://www.gossamer-threads.com/lists/lucene/java-user/39125#39125">the Lucene users's mailing list</a>):
+ * <blockquote>[One would override the Similarity in] ... any situation where you know more about your data then just
+ * that
+ * it's "text" is a situation where it *might* make sense to to override your
+ * Similarity method.</blockquote>
+ * </p>
+ */
+package org.apache.lucene.search.similarities;
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,93 +1,90 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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.
--->
-<html>
-<head></head>
-<body>
-The calculus of spans.
-
-<p>A span is a <code><doc,startPosition,endPosition></code> tuple.</p>
-
-<p>The following span query operators are implemented:
-
-<ul>
-
-<li>A {@link org.apache.lucene.search.spans.SpanTermQuery SpanTermQuery} matches all spans
-containing a particular {@link org.apache.lucene.index.Term Term}.</li>
-
-<li> A {@link org.apache.lucene.search.spans.SpanNearQuery SpanNearQuery} matches spans
-which occur near one another, and can be used to implement things like
-phrase search (when constructed from {@link org.apache.lucene.search.spans.SpanTermQuery}s)
-and inter-phrase proximity (when constructed from other {@link org.apache.lucene.search.spans.SpanNearQuery}s).</li>
-
-<li>A {@link org.apache.lucene.search.spans.SpanOrQuery SpanOrQuery} merges spans from a
-number of other {@link org.apache.lucene.search.spans.SpanQuery}s.</li>
-
-<li>A {@link org.apache.lucene.search.spans.SpanNotQuery SpanNotQuery} removes spans
-matching one {@link org.apache.lucene.search.spans.SpanQuery SpanQuery} which overlap (or comes
-near) another. This can be used, e.g., to implement within-paragraph
-search.</li>
-
-<li>A {@link org.apache.lucene.search.spans.SpanFirstQuery SpanFirstQuery} matches spans
-matching <code>q</code> whose end position is less than
-<code>n</code>. This can be used to constrain matches to the first
-part of the document.</li>
-
-<li>A {@link org.apache.lucene.search.spans.SpanPositionRangeQuery SpanPositionRangeQuery} is
-a more general form of SpanFirstQuery that can constrain matches to arbitrary portions of the document.</li>
-
-</ul>
-
-In all cases, output spans are minimally inclusive. In other words, a
-span formed by matching a span in x and y starts at the lesser of the
-two starts and ends at the greater of the two ends.
-</p>
-
-<p>For example, a span query which matches "John Kerry" within ten
-words of "George Bush" within the first 100 words of the document
-could be constructed with:
-<pre class="prettyprint">
-SpanQuery john = new SpanTermQuery(new Term("content", "john"));
-SpanQuery kerry = new SpanTermQuery(new Term("content", "kerry"));
-SpanQuery george = new SpanTermQuery(new Term("content", "george"));
-SpanQuery bush = new SpanTermQuery(new Term("content", "bush"));
-
-SpanQuery johnKerry =
- new SpanNearQuery(new SpanQuery[] {john, kerry}, 0, true);
-
-SpanQuery georgeBush =
- new SpanNearQuery(new SpanQuery[] {george, bush}, 0, true);
-
-SpanQuery johnKerryNearGeorgeBush =
- new SpanNearQuery(new SpanQuery[] {johnKerry, georgeBush}, 10, false);
-
-SpanQuery johnKerryNearGeorgeBushAtStart =
- new SpanFirstQuery(johnKerryNearGeorgeBush, 100);
-</pre>
-
-<p>Span queries may be freely intermixed with other Lucene queries.
-So, for example, the above query can be restricted to documents which
-also use the word "iraq" with:
-
-<pre class="prettyprint">
-Query query = new BooleanQuery();
-query.add(johnKerryNearGeorgeBushAtStart, true, false);
-query.add(new TermQuery("content", "iraq"), true, false);
-</pre>
-
-</body>
-</html>
+/*
+ * 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.
+ */
+
+/**
+ * The calculus of spans.
+ *
+ * <p>A span is a <code><doc,startPosition,endPosition></code> tuple.</p>
+ *
+ * <p>The following span query operators are implemented:
+ *
+ * <ul>
+ *
+ * <li>A {@link org.apache.lucene.search.spans.SpanTermQuery SpanTermQuery} matches all spans
+ * containing a particular {@link org.apache.lucene.index.Term Term}.</li>
+ *
+ * <li> A {@link org.apache.lucene.search.spans.SpanNearQuery SpanNearQuery} matches spans
+ * which occur near one another, and can be used to implement things like
+ * phrase search (when constructed from {@link org.apache.lucene.search.spans.SpanTermQuery}s)
+ * and inter-phrase proximity (when constructed from other {@link org.apache.lucene.search.spans.SpanNearQuery}s).</li>
+ *
+ * <li>A {@link org.apache.lucene.search.spans.SpanOrQuery SpanOrQuery} merges spans from a
+ * number of other {@link org.apache.lucene.search.spans.SpanQuery}s.</li>
+ *
+ * <li>A {@link org.apache.lucene.search.spans.SpanNotQuery SpanNotQuery} removes spans
+ * matching one {@link org.apache.lucene.search.spans.SpanQuery SpanQuery} which overlap (or comes
+ * near) another. This can be used, e.g., to implement within-paragraph
+ * search.</li>
+ *
+ * <li>A {@link org.apache.lucene.search.spans.SpanFirstQuery SpanFirstQuery} matches spans
+ * matching <code>q</code> whose end position is less than
+ * <code>n</code>. This can be used to constrain matches to the first
+ * part of the document.</li>
+ *
+ * <li>A {@link org.apache.lucene.search.spans.SpanPositionRangeQuery SpanPositionRangeQuery} is
+ * a more general form of SpanFirstQuery that can constrain matches to arbitrary portions of the document.</li>
+ *
+ * </ul>
+ *
+ * In all cases, output spans are minimally inclusive. In other words, a
+ * span formed by matching a span in x and y starts at the lesser of the
+ * two starts and ends at the greater of the two ends.
+ * </p>
+ *
+ * <p>For example, a span query which matches "John Kerry" within ten
+ * words of "George Bush" within the first 100 words of the document
+ * could be constructed with:
+ * <pre class="prettyprint">
+ * SpanQuery john = new SpanTermQuery(new Term("content", "john"));
+ * SpanQuery kerry = new SpanTermQuery(new Term("content", "kerry"));
+ * SpanQuery george = new SpanTermQuery(new Term("content", "george"));
+ * SpanQuery bush = new SpanTermQuery(new Term("content", "bush"));
+ *
+ * SpanQuery johnKerry =
+ * new SpanNearQuery(new SpanQuery[] {john, kerry}, 0, true);
+ *
+ * SpanQuery georgeBush =
+ * new SpanNearQuery(new SpanQuery[] {george, bush}, 0, true);
+ *
+ * SpanQuery johnKerryNearGeorgeBush =
+ * new SpanNearQuery(new SpanQuery[] {johnKerry, georgeBush}, 10, false);
+ *
+ * SpanQuery johnKerryNearGeorgeBushAtStart =
+ * new SpanFirstQuery(johnKerryNearGeorgeBush, 100);
+ * </pre>
+ *
+ * <p>Span queries may be freely intermixed with other Lucene queries.
+ * So, for example, the above query can be restricted to documents which
+ * also use the word "iraq" with:
+ *
+ * <pre class="prettyprint">
+ * Query query = new BooleanQuery();
+ * query.add(johnKerryNearGeorgeBushAtStart, true, false);
+ * query.add(new TermQuery("content", "iraq"), true, false);
+ * </pre>
+ */
+package org.apache.lucene.search.spans;
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,25 +1,21 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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
+/*
+ * 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.
+ */
- 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.
--->
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-</head>
-<body>
-Binary i/o API, used for all index data.
-</body>
-</html>
+/**
+ * Binary i/o API, used for all index data.
+ */
+package org.apache.lucene.store;
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,47 +1,46 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- dk.brics.automaton
-
- Copyright (c) 2001-2009 Anders Moeller
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
- 1. Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- 2. Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in the
- documentation and/or other materials provided with the distribution.
- 3. The name of the author may not be used to endorse or promote products
- derived from this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
- IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
- IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
- THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--->
-<html>
-<body>
-Finite-state automaton for regular expressions.
-<p>
-This package contains a full DFA/NFA implementation with Unicode
-alphabet and support for all standard (and a number of non-standard)
-regular expression operations.
-<p>
-The most commonly used functionality is located in the classes
-<tt>{@link org.apache.lucene.util.automaton.Automaton}</tt> and
-<tt>{@link org.apache.lucene.util.automaton.RegExp}</tt>.
-<p>
-For more information, go to the package home page at
-<tt><a href="http://www.brics.dk/automaton/"
-target="_top">http://www.brics.dk/automaton/</a></tt>.
-@lucene.experimental
-</body>
-</html>
+/*
+ * dk.brics.automaton
+ *
+ * Copyright (c) 2001-2009 Anders Moeller
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * Finite-state automaton for regular expressions.
+ * <p>
+ * This package contains a full DFA/NFA implementation with Unicode
+ * alphabet and support for all standard (and a number of non-standard)
+ * regular expression operations.
+ * <p>
+ * The most commonly used functionality is located in the classes
+ * <tt>{@link org.apache.lucene.util.automaton.Automaton}</tt> and
+ * <tt>{@link org.apache.lucene.util.automaton.RegExp}</tt>.
+ * <p>
+ * For more information, go to the package home page at
+ * <tt><a href="http://www.brics.dk/automaton/"
+ * target="_top">http://www.brics.dk/automaton/</a></tt>.
+ * @lucene.experimental
+ */
+package org.apache.lucene.util.automaton;
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,92 +1,88 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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
+/*
+ * 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.
+ */
- 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.
--->
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-</head>
-<body>
-Finite state transducers
-<p>
-This package implements <a href="http://en.wikipedia.org/wiki/Finite_state_transducer">
-Finite State Transducers</a> with the following characteristics:
-<ul>
- <li>Fast and low memory overhead construction of the minimal FST
- (but inputs must be provided in sorted order)</li>
- <li>Low object overhead and quick deserialization (byte[] representation)</li>
- <li>Optional two-pass compression: {@link org.apache.lucene.util.fst.FST#pack FST.pack()}</li>
- <li>{@link org.apache.lucene.util.fst.Util#getByOutput Lookup-by-output} when the
- outputs are in sorted order (e.g., ordinals or file pointers)</li>
- <li>Pluggable {@link org.apache.lucene.util.fst.Outputs Outputs} representation</li>
- <li>{@link org.apache.lucene.util.fst.Util#shortestPaths N-shortest-paths} search by
- weight</li>
- <li>Enumerators ({@link org.apache.lucene.util.fst.IntsRefFSTEnum IntsRef} and {@link org.apache.lucene.util.fst.BytesRefFSTEnum BytesRef}) that behave like {@link java.util.SortedMap SortedMap} iterators
-</ul>
-<p>
-FST Construction example:
-<pre class="prettyprint">
- // Input values (keys). These must be provided to Builder in Unicode sorted order!
- String inputValues[] = {"cat", "dog", "dogs"};
- long outputValues[] = {5, 7, 12};
-
- PositiveIntOutputs outputs = PositiveIntOutputs.getSingleton();
- Builder<Long> builder = new Builder<Long>(INPUT_TYPE.BYTE1, outputs);
- BytesRef scratchBytes = new BytesRef();
- IntsRefBuilder scratchInts = new IntsRefBuilder();
- for (int i = 0; i < inputValues.length; i++) {
- scratchBytes.copyChars(inputValues[i]);
- builder.add(Util.toIntsRef(scratchBytes, scratchInts), outputValues[i]);
- }
- FST<Long> fst = builder.finish();
-</pre>
-Retrieval by key:
-<pre class="prettyprint">
- Long value = Util.get(fst, new BytesRef("dog"));
- System.out.println(value); // 7
-</pre>
-Retrieval by value:
-<pre class="prettyprint">
- // Only works because outputs are also in sorted order
- IntsRef key = Util.getByOutput(fst, 12);
- System.out.println(Util.toBytesRef(key, scratchBytes).utf8ToString()); // dogs
-</pre>
-Iterate over key-value pairs in sorted order:
-<pre class="prettyprint">
- // Like TermsEnum, this also supports seeking (advance)
- BytesRefFSTEnum<Long> iterator = new BytesRefFSTEnum<Long>(fst);
- while (iterator.next() != null) {
- InputOutput<Long> mapEntry = iterator.current();
- System.out.println(mapEntry.input.utf8ToString());
- System.out.println(mapEntry.output);
- }
-</pre>
-N-shortest paths by weight:
-<pre class="prettyprint">
- Comparator<Long> comparator = new Comparator<Long>() {
- public int compare(Long left, Long right) {
- return left.compareTo(right);
- }
- };
- Arc<Long> firstArc = fst.getFirstArc(new Arc<Long>());
- MinResult<Long> paths[] = Util.shortestPaths(fst, firstArc, comparator, 2);
- System.out.println(Util.toBytesRef(paths[0].input, scratchBytes).utf8ToString()); // cat
- System.out.println(paths[0].output); // 5
- System.out.println(Util.toBytesRef(paths[1].input, scratchBytes).utf8ToString()); // dog
- System.out.println(paths[1].output); // 7
-</pre>
-</body>
-</html>
+/**
+ * Finite state transducers
+ * <p>
+ * This package implements <a href="http://en.wikipedia.org/wiki/Finite_state_transducer">
+ * Finite State Transducers</a> with the following characteristics:
+ * <ul>
+ * <li>Fast and low memory overhead construction of the minimal FST
+ * (but inputs must be provided in sorted order)</li>
+ * <li>Low object overhead and quick deserialization (byte[] representation)</li>
+ * <li>Optional two-pass compression: {@link org.apache.lucene.util.fst.FST#pack FST.pack()}</li>
+ * <li>{@link org.apache.lucene.util.fst.Util#getByOutput Lookup-by-output} when the
+ * outputs are in sorted order (e.g., ordinals or file pointers)</li>
+ * <li>Pluggable {@link org.apache.lucene.util.fst.Outputs Outputs} representation</li>
+ * <li>{@link org.apache.lucene.util.fst.Util#shortestPaths N-shortest-paths} search by
+ * weight</li>
+ * <li>Enumerators ({@link org.apache.lucene.util.fst.IntsRefFSTEnum IntsRef} and {@link org.apache.lucene.util.fst.BytesRefFSTEnum BytesRef}) that behave like {@link java.util.SortedMap SortedMap} iterators
+ * </ul>
+ * <p>
+ * FST Construction example:
+ * <pre class="prettyprint">
+ * // Input values (keys). These must be provided to Builder in Unicode sorted order!
+ * String inputValues[] = {"cat", "dog", "dogs"};
+ * long outputValues[] = {5, 7, 12};
+ *
+ * PositiveIntOutputs outputs = PositiveIntOutputs.getSingleton();
+ * Builder<Long> builder = new Builder<Long>(INPUT_TYPE.BYTE1, outputs);
+ * BytesRef scratchBytes = new BytesRef();
+ * IntsRefBuilder scratchInts = new IntsRefBuilder();
+ * for (int i = 0; i < inputValues.length; i++) {
+ * scratchBytes.copyChars(inputValues[i]);
+ * builder.add(Util.toIntsRef(scratchBytes, scratchInts), outputValues[i]);
+ * }
+ * FST<Long> fst = builder.finish();
+ * </pre>
+ * Retrieval by key:
+ * <pre class="prettyprint">
+ * Long value = Util.get(fst, new BytesRef("dog"));
+ * System.out.println(value); // 7
+ * </pre>
+ * Retrieval by value:
+ * <pre class="prettyprint">
+ * // Only works because outputs are also in sorted order
+ * IntsRef key = Util.getByOutput(fst, 12);
+ * System.out.println(Util.toBytesRef(key, scratchBytes).utf8ToString()); // dogs
+ * </pre>
+ * Iterate over key-value pairs in sorted order:
+ * <pre class="prettyprint">
+ * // Like TermsEnum, this also supports seeking (advance)
+ * BytesRefFSTEnum<Long> iterator = new BytesRefFSTEnum<Long>(fst);
+ * while (iterator.next() != null) {
+ * InputOutput<Long> mapEntry = iterator.current();
+ * System.out.println(mapEntry.input.utf8ToString());
+ * System.out.println(mapEntry.output);
+ * }
+ * </pre>
+ * N-shortest paths by weight:
+ * <pre class="prettyprint">
+ * Comparator<Long> comparator = new Comparator<Long>() {
+ * public int compare(Long left, Long right) {
+ * return left.compareTo(right);
+ * }
+ * };
+ * Arc<Long> firstArc = fst.getFirstArc(new Arc<Long>());
+ * MinResult<Long> paths[] = Util.shortestPaths(fst, firstArc, comparator, 2);
+ * System.out.println(Util.toBytesRef(paths[0].input, scratchBytes).utf8ToString()); // cat
+ * System.out.println(paths[0].output); // 5
+ * System.out.println(Util.toBytesRef(paths[1].input, scratchBytes).utf8ToString()); // dog
+ * System.out.println(paths[1].output); // 7
+ * </pre>
+ */
+package org.apache.lucene.util.fst;
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/mutable/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/mutable/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/mutable/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/mutable/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/mutable/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/mutable/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/mutable/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,25 +1,21 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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
+/*
+ * 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.
+ */
- 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.
--->
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-</head>
-<body>
-Comparable object wrappers
-</body>
-</html>
\ No newline at end of file
+/**
+ * Comparable object wrappers
+ */
+package org.apache.lucene.util.mutable;
\ No newline at end of file
Copied: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/package-info.java (from r1657982, lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/package.html)
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/package-info.java?p2=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/package-info.java&p1=lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/package.html&r1=1657982&r2=1658029&rev=1658029&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/package-info.java Sat Feb 7 07:38:44 2015
@@ -1,25 +1,21 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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
+/*
+ * 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.
+ */
- 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.
--->
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-</head>
-<body>
-Some utility classes.
-</body>
-</html>
+/**
+ * Some utility classes.
+ */
+package org.apache.lucene.util;