First draft of LUCENE-5317

dev-tools/idea/lucene/concordance/concordance.iml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="false">
+    <output url="file://$MODULE_DIR$/../../idea-build/lucene/concordance/classes/java" />
+    <output-test url="file://$MODULE_DIR$/../../idea-build/lucene/concordance/classes/test" />
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/src/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="TEST" name="JUnit" level="project" />
+    <orderEntry type="module" scope="TEST" module-name="lucene-test-framework" />
+    <orderEntry type="module" module-name="lucene-core" />
+    <orderEntry type="module" module-name="queries" />
+  </component>
+</module>
+
+

dev-tools/maven/lucene/concordance/pom.xml.template

@@ -0,0 +1,69 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <!--
+    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.
+  -->
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.apache.lucene</groupId>
+    <artifactId>lucene-parent</artifactId>
+    <version>@version@</version>
+    <relativePath>../pom.xml</relativePath>
+  </parent>
+  <groupId>org.apache.lucene</groupId>
+  <artifactId>lucene-concordance</artifactId>
+  <packaging>jar</packaging>
+  <name>Lucene Concordance</name>
+  <description>Lucene Concordance Module</description>
+  <properties>
+    <module-directory>lucene/concordance</module-directory>
+    <relative-top-level>../../..</relative-top-level>
+    <module-path>${relative-top-level}/${module-directory}</module-path>
+  </properties>
+  <scm>
+    <connection>scm:svn:${vc-anonymous-base-url}/${module-directory}</connection>
+    <developerConnection>scm:svn:${vc-dev-base-url}/${module-directory}</developerConnection>
+    <url>${vc-browse-base-url}/${module-directory}</url>
+  </scm>
+  <dependencies>
+    <dependency>
+      <!-- lucene-test-framework dependency must be declared before lucene-core -->
+      <groupId>org.apache.lucene</groupId>
+      <artifactId>lucene-test-framework</artifactId>
+      <scope>test</scope>
+    </dependency>
+    @lucene-concordance.internal.dependencies@
+    @lucene-concordance.external.dependencies@
+    @lucene-concordance.internal.test.dependencies@
+    @lucene-concordance.external.test.dependencies@
+  </dependencies>
+  <build>
+    <sourceDirectory>${module-path}/src/java</sourceDirectory>
+    <testSourceDirectory>${module-path}/src/test</testSourceDirectory>
+    <testResources>
+      <testResource>
+        <directory>${project.build.testSourceDirectory}</directory>
+        <excludes>
+          <exclude>**/*.java</exclude>
+        </excludes>
+      </testResource>
+    </testResources>
+  </build>
+</project>
+

dev-tools/maven/lucene/pom.xml.template

@@ -47,6 +47,7 @@
     <module>analysis</module>
     <module>benchmark</module>
     <module>classification</module>
+    <module>concordance</module>
     <module>demo</module>
     <module>expressions</module>
     <module>facet</module>

lucene/build.xml

@@ -182,6 +182,7 @@
     <check-missing-javadocs dir="build/docs/spatial" level="method"/>
     <!-- spatial-extras: problems -->
     <check-missing-javadocs dir="build/docs/suggest" level="method"/>
+    <check-missing-javadocs dir="build/docs/concordance" level="method"/>
     <!-- test-framework: problems -->
 
     <!-- too much to fix core/ for now, but enforce full javadocs for key packages -->

lucene/concordance/build.xml

@@ -0,0 +1,40 @@
+<!--
+  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.
+  -->
+
+<project name="concordance" default="default">
+
+  <description>
+  Executes concordance search
+  </description>
+
+  <import file="../module-build.xml"/>
+
+  <path id="classpath">
+    <pathelement path="${queries.jar}"/>
+    <path refid="base.classpath"/>
+  </path>
+
+  <target name="compile-core" depends="jar-queries,common.compile-core"/>
+  <target name="javadocs" depends="javadocs-queries,compile-core,check-javadocs-uptodate"
+          unless="javadocs-uptodate-${name}">
+    <invoke-module-javadoc>
+      <links>
+        <link href="../queries"/>
+      </links>
+    </invoke-module-javadoc>
+  </target>
+</project>

lucene/concordance/ivy.xml

@@ -0,0 +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.    
+-->
+<ivy-module version="2.0">
+  <info organisation="org.apache.lucene" module="concordance"/>
+</ivy-module>

lucene/concordance/src/java/org/apache/lucene/concordance/charoffsets/DocTokenOffsets.java

@@ -0,0 +1,95 @@
+/*
+ * 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.
+ */
+
+package org.apache.lucene.concordance.charoffsets;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.lucene.analysis.tokenattributes.OffsetAttribute;
+import org.apache.lucene.analysis.tokenattributes.OffsetAttributeImpl;
+import org.apache.lucene.document.Document;
+
+
+
+/**
+ * Simple class to store a document id (atomic and unique), a StoredDocument,
+ * and the offsets for a SpanQuery hit
+ */
+public class DocTokenOffsets {
+  private int atomicDocId = -1;
+  private long uniqueId = -1;
+  private Document document = null;
+  private List<OffsetAttribute> offsets = new ArrayList<>();
+
+  public void addOffset(int start, int end) {
+    OffsetAttributeImpl offset = new OffsetAttributeImpl();
+    offset.setOffset(start, end);
+    offsets.add(offset);
+  }
+
+  public void reset(int base, int atomicDocId, Document d) {
+    this.atomicDocId = atomicDocId;
+    this.uniqueId = base + atomicDocId;
+    setDocument(d);
+    offsets.clear();
+  }
+
+  public List<OffsetAttribute> getOffsets() {
+    return offsets;
+  }
+
+  public Document getDocument() {
+    return document;
+  }
+
+  public void setDocument(Document d) {
+    this.document = d;
+  }
+
+  /*
+   * required by DocTokenOffsetsIterator
+   */
+  protected int getAtomicDocId() {
+    return atomicDocId;
+  }
+
+  public long getUniqueDocId() {
+    return uniqueId;
+  }
+
+  public DocTokenOffsets deepishCopy() {
+    DocTokenOffsets copy = new DocTokenOffsets();
+    copy.atomicDocId = atomicDocId;
+    copy.uniqueId = uniqueId;
+    copy.document = document;
+    List<OffsetAttribute> copyOffsets = new ArrayList<OffsetAttribute>();
+    copyOffsets.addAll(offsets);
+    copy.offsets = copyOffsets;
+    return copy;
+  }
+
+  public boolean isEmpty() {
+    if (atomicDocId < 0)
+      return true;
+    return false;
+  }
+
+  public void pseudoEmpty() {
+    atomicDocId = -1;
+  }
+}