LUCENE-3795: fix javadoc warnings, add pom files

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene3795_lsp_spatial_module@1291669 13f79535-47bb-0310-9956-ffa450edef68

dev-tools/eclipse/dot.classpath

@@ -55,6 +55,10 @@
 	<classpathentry kind="src" path="modules/queryparser/src/test"/>
 	<classpathentry kind="src" path="modules/suggest/src/java"/>
 	<classpathentry kind="src" path="modules/suggest/src/test"/>
+	<classpathentry kind="src" path="modules/spatial/base/src/java"/>
+	<classpathentry kind="src" path="modules/spatial/base/src/test"/>
+	<classpathentry kind="src" path="modules/spatial/strategy/src/java"/>
+	<classpathentry kind="src" path="modules/spatial/strategy/src/test"/>
 	<classpathentry kind="src" path="solr/core/src/java"/>
 	<classpathentry kind="src" path="solr/core/src/test"/>
 	<classpathentry kind="src" path="solr/core/src/test-files"/>

dev-tools/maven/modules/spatial/base/pom.xml.template

@@ -0,0 +1,71 @@
+<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>../../../lucene/pom.xml</relativePath>
+  </parent>
+  <groupId>org.apache.lucene</groupId>
+  <artifactId>lucene-spatial-base</artifactId>
+  <packaging>jar</packaging>
+  <name>Lucene Spatial Base</name>
+  <description>Spatial Code w/o lucene dependencies</description>
+  <properties>
+    <module-directory>modules/spatial/base</module-directory>
+    <build-directory>../build/base</build-directory>
+  </properties>
+  <dependencies>
+    <dependency> 
+      <!-- lucene-test-framework dependency must be declared before lucene-core -->
+      <groupId>${project.groupId}</groupId>
+      <artifactId>lucene-test-framework</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+    
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>commons-lang</groupId>
+      <artifactId>commons-lang</artifactId>
+    </dependency>
+  </dependencies>
+  <build>
+    <directory>${build-directory}</directory>
+    <outputDirectory>${build-directory}/classes/java</outputDirectory>
+    <testOutputDirectory>${build-directory}/classes/test</testOutputDirectory>
+    <sourceDirectory>src/java</sourceDirectory>
+    <testSourceDirectory>src/test</testSourceDirectory>
+    <testResources>
+      <testResource>
+        <directory>${project.build.testSourceDirectory}</directory>
+        <excludes>
+          <exclude>**/*.java</exclude>
+        </excludes>
+      </testResource>
+    </testResources>
+  </build>
+</project>

dev-tools/maven/modules/spatial/pom.xml.template

@@ -0,0 +1,49 @@
+<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>../../lucene/pom.xml</relativePath>
+  </parent>
+  <groupId>org.apache.lucene</groupId>
+  <artifactId>lucene-spatial-modules-aggregator</artifactId>
+  <name>Lucene Spatial Modules aggregator POM</name>
+  <packaging>pom</packaging>
+  <modules>
+    <module>base</module>
+    <module>strategy</module>
+  </modules>
+  <build>
+    <directory>build/lucene-spatial-modules-aggregator</directory>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-deploy-plugin</artifactId>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

dev-tools/maven/modules/spatial/strategy/pom.xml.template

@@ -0,0 +1,90 @@
+<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>../../../lucene/pom.xml</relativePath>
+  </parent>
+  <groupId>org.apache.lucene</groupId>
+  <artifactId>lucene-spatial-strategy</artifactId>
+  <packaging>jar</packaging>
+  <name>Lucene Spatial Strategies</name>
+  <description>    
+  	Spatial Strategies for Apache Lucene
+  </description>
+  <properties>
+    <module-directory>modules/spatial/strategy</module-directory>
+    <build-directory>../build/strategy</build-directory>
+  </properties>
+  <dependencies>
+    <dependency> 
+      <!-- lucene-test-framework dependency must be declared before lucene-core -->
+      <groupId>${project.groupId}</groupId>
+      <artifactId>lucene-test-framework</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>lucene-spatial-base</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>lucene-core</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>lucene-queries</artifactId>
+      <version>${lucene.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>lucene-analyzers-common</artifactId>
+      <version>${lucene.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>lucene-benchmark</artifactId>
+      <version>${lucene.version}</version>
+      <optional>true</optional>
+    </dependency>
+  </dependencies>
+  <build>
+    <directory>${build-directory}</directory>
+    <outputDirectory>${build-directory}/classes/java</outputDirectory>
+    <testOutputDirectory>${build-directory}/classes/test</testOutputDirectory>
+    <sourceDirectory>src/java</sourceDirectory>
+    <testSourceDirectory>src/test</testSourceDirectory>
+    <testResources>
+      <testResource>
+        <directory>${project.build.testSourceDirectory}</directory>
+        <excludes>
+          <exclude>**/*.java</exclude>
+        </excludes>
+      </testResource>
+    </testResources>
+  </build>
+</project>

modules/spatial/base/src/java/org/apache/lucene/spatial/base/context/SpatialContext.java

@@ -112,7 +112,6 @@ public abstract class SpatialContext {
 
   /**
    * Is this a geospatial context (true) or simply 2d spatial (false)
-   * @return
    */
   public boolean isGeo() {
     return getUnits().isGeo();
@@ -156,7 +155,6 @@ public abstract class SpatialContext {
    *
    * @param ctr
    * @param distance The units of "distance" should be the same as {@link #getUnits()}.
-   * @return
    */
   public abstract Circle makeCircle(Point ctr, double distance);
 

modules/spatial/base/src/java/org/apache/lucene/spatial/base/context/SpatialContextFactory.java

@@ -41,7 +41,6 @@ public abstract class SpatialContextFactory {
    * then {@link SimpleSpatialContextFactory} is chosen.
    * @param args
    * @param classLoader
-   * @return
    */
   public static SpatialContext makeSpatialContext(Map<String,String> args, ClassLoader classLoader) {
     SpatialContextFactory instance;

modules/spatial/base/src/java/org/apache/lucene/spatial/base/prefix/Node.java

@@ -165,9 +165,6 @@ public abstract class Node implements Comparable<Node> {
    * cell's boundary.
    * Precondition: Never called when getLevel() == maxLevel.
    * Precondition: this.getShape().relate(p) != DISJOINT.
-   *
-   * @param p
-   * @return
    */
   public abstract Node getSubCell(Point p);
 

modules/spatial/base/src/java/org/apache/lucene/spatial/base/query/SpatialArgs.java

@@ -88,7 +88,6 @@ public class SpatialArgs {
 
   /**
    * Considers {@link SpatialOperation#BBoxWithin} in returning the shape.
-   * @return
    */
   public Shape getShape() {
     if (shape != null && (operation == SpatialOperation.BBoxWithin || operation == SpatialOperation.BBoxIntersects))

modules/spatial/base/src/java/org/apache/lucene/spatial/base/shape/SpatialRelation.java

@@ -43,7 +43,6 @@ public enum SpatialRelation {
    * If you were to call aShape.relate(bShape) and aShape.relate(cShape), you could call
    * this to merge the intersect results as if bShape & cShape were combined into {@link MultiShape}.
    * @param other
-   * @return
    */
   public SpatialRelation combine(SpatialRelation other) {
     if (this == other)

modules/spatial/base/src/java/org/apache/lucene/spatial/base/shape/simple/CircleImpl.java

@@ -69,7 +69,6 @@ public class CircleImpl implements Circle {
 
   /**
    * Note that the bounding box might contain a minX that is > maxX, due to WGS84 dateline.
-   * @return
    */
   @Override
   public Rectangle getBoundingBox() {

modules/spatial/base/src/java/org/apache/lucene/spatial/base/shape/simple/GeoCircleImpl.java

@@ -68,8 +68,8 @@ public class GeoCircleImpl extends CircleImpl {
 
   /**
    * Called after bounding box is intersected.
-   * @bboxSect INTERSECTS or CONTAINS from enclosingBox's intersection
+   * @param bboxSect INTERSECTS or CONTAINS from enclosingBox's intersection
-   * @result DISJOINT, CONTAINS, or INTERSECTS (not WITHIN)
+   * @return DISJOINT, CONTAINS, or INTERSECTS (not WITHIN)
    */
   @Override
   protected SpatialRelation relateRectanglePhase2(Rectangle r, SpatialRelation bboxSect, SpatialContext ctx) {

modules/spatial/base/src/java/overview.html

@@ -0,0 +1,23 @@
+<!--
+ 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>
+    <title>Apache Lucene Spatial Base</title>
+  </head>
+  <body>
+  </body>
+</html>

modules/spatial/build.xml

@@ -60,18 +60,18 @@
   <target name="build-artifacts-and-tests" depends="default,compile-test" />
 
   <target name="dist-maven" depends="default,javadocs">
-    <ant dir="base" target="clean" />
+    <ant dir="base" target="dist-maven" />
-    <ant dir="strategy" target="clean" />
+    <ant dir="strategy" target="dist-maven" />
   </target>  	
 
   <target name="javadocs">
-    <ant dir="base" target="clean" />
+    <ant dir="base" target="javadocs" />
-    <ant dir="strategy" target="clean" />
+    <ant dir="strategy" target="javadocs" />
   </target>  	
 
   <target name="javadocs-index.html">
-    <ant dir="base" target="clean" />
+    <ant dir="base" target="javadocs-index.html" />
-    <ant dir="strategy" target="clean" />
+    <ant dir="strategy" target="javadocs-index.html" />
   </target>
 	
 </project>

modules/spatial/strategy/src/java/overview.html

@@ -0,0 +1,23 @@
+<!--
+ 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>
+    <title>Apache Lucene Spatial Strategies</title>
+  </head>
+  <body>
+  </body>
+</html>