* 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.

*/

* A point type that indexes a point in an n-dimensional space as separate fields and supports range queries.

* See {@link LatLonType} for geo-spatial queries.

*/

  @Override

  protected void init(IndexSchema schema, Map<String, String> args) {

    SolrParams p = new MapSolrParams(args);

    dimension = p.getInt(DIMENSION, DEFAULT_DIMENSION);

    if (dimension < 1) {

      throw new SolrException(SolrException.ErrorCode.BAD_REQUEST,

              "The dimension must be > 0: " + dimension);

    }

    args.remove(DIMENSION);

    this.schema = schema;

    super.init(schema, args);

    // cache suffixes

    createSuffixCache(dimension);

  }

  @Override

  public boolean isPolyField() {

    return true;   // really only true if the field is indexed

  }

  @Override

  public Fieldable[] createFields(SchemaField field, String externalVal, float boost) {

    String[] point = new String[0];

    try {

      point = DistanceUtils.parsePoint(null, externalVal, dimension);

    } catch (InvalidGeoException e) {

      throw new SolrException(SolrException.ErrorCode.BAD_REQUEST, e);

    }

    // TODO: this doesn't currently support polyFields as sub-field types

    Fieldable[] f = new Fieldable[ (field.indexed() ? dimension : 0) + (field.stored() ? 1 : 0) ];

    if (field.indexed()) {

      for (int i=0; i<dimension; i++) {

        f[i] = subField(field, i).createField(point[i], boost);

      }

    }

    if (field.stored()) {

      String storedVal = externalVal;  // normalize or not?

      f[f.length - 1] = createField(field.getName(), storedVal,

                getFieldStore(field, storedVal), Field.Index.NO, Field.TermVector.NO,

                false, IndexOptions.DOCS_AND_FREQS_AND_POSITIONS, boost);

    }

   

    return f;

  }

  @Override

  public ValueSource getValueSource(SchemaField field, QParser parser) {

    ArrayList<ValueSource> vs = new ArrayList<ValueSource>(dimension);

    for (int i=0; i<dimension; i++) {

      SchemaField sub = subField(field, i);

      vs.add(sub.getType().getValueSource(sub, parser));

    }

    return new PointTypeValueSource(field, vs);

  }

  /**

   * It never makes sense to create a single field, so make it impossible to happen by

   * throwing UnsupportedOperationException

   *

   */

  @Override

  public Fieldable createField(SchemaField field, String externalVal, float boost) {

    throw new UnsupportedOperationException("PointType uses multiple fields.  field=" + field.getName());

  }

  @Override

  public void write(XMLWriter xmlWriter, String name, Fieldable f) throws IOException {

    xmlWriter.writeStr(name, f.stringValue());

  }

  @Override

  public void write(TextResponseWriter writer, String name, Fieldable f) throws IOException {

    writer.writeStr(name, f.stringValue(), false);

  }

  @Override

  public SortField getSortField(SchemaField field, boolean top) {

    throw new SolrException(SolrException.ErrorCode.BAD_REQUEST, "Sorting not suported on PointType " + field.getName());

  }

  @Override

  /**

   * Care should be taken in calling this with higher order dimensions for performance reasons.

   */

  public Query getRangeQuery(QParser parser, SchemaField field, String part1, String part2, boolean minInclusive, boolean maxInclusive) {

    //Query could look like: [x1,y1 TO x2,y2] for 2 dimension, but could look like: [x1,y1,z1 TO x2,y2,z2], and can be extrapolated to n-dimensions

    //thus, this query essentially creates a box, cube, etc.

    String[] p1;

    String[] p2;

    try {

      p1 = DistanceUtils.parsePoint(null, part1, dimension);

      p2 = DistanceUtils.parsePoint(null, part2, dimension);

    } catch (InvalidGeoException e) {

      throw new SolrException(SolrException.ErrorCode.BAD_REQUEST, e);

    }

    BooleanQuery result = new BooleanQuery(true);

    for (int i = 0; i < dimension; i++) {

      SchemaField subSF = subField(field, i);

      // points must currently be ordered... should we support specifying any two opposite corner points?

      result.add(subSF.getType().getRangeQuery(parser, subSF, p1[i], p2[i], minInclusive, maxInclusive), BooleanClause.Occur.MUST);

    }

    return result;

  }

  @Override

  public Query getFieldQuery(QParser parser, SchemaField field, String externalVal) {

    String[] p1 = new String[0];

    try {

      p1 = DistanceUtils.parsePoint(null, externalVal, dimension);

    } catch (InvalidGeoException e) {

      throw new SolrException(SolrException.ErrorCode.BAD_REQUEST, e);

    }

    //TODO: should we assert that p1.length == dimension?

    BooleanQuery bq = new BooleanQuery(true);

    for (int i = 0; i < dimension; i++) {

      SchemaField sf = subField(field, i);

      Query tq = sf.getType().getFieldQuery(parser, sf, p1[i]);

      bq.add(tq, BooleanClause.Occur.MUST);

    }

    return bq;

  }

  /**

   * Calculates the range and creates a RangeQuery (bounding box) wrapped in a BooleanQuery (unless the dimension is 1, one range for every dimension, AND'd together by a Boolean

   * @param parser The parser

   * @param options The {@link org.apache.solr.search.SpatialOptions} for this filter.

   * @return The Query representing the bounding box around the point.

   */

  public Query createSpatialQuery(QParser parser, SpatialOptions options) {

    Query result = null;

    double [] point = new double[0];

    try {

      point = DistanceUtils.parsePointDouble(null, options.pointStr, dimension);

    } catch (InvalidGeoException e) {

      throw new SolrException(SolrException.ErrorCode.BAD_REQUEST, e);

    }

    if (dimension == 1){

      //TODO: Handle distance measures

      String lower = String.valueOf(point[0] - options.distance);

      String upper = String.valueOf(point[0] + options.distance);

      SchemaField subSF = subField(options.field, 0);

      // points must currently be ordered... should we support specifying any two opposite corner points?

      result = subSF.getType().getRangeQuery(parser, subSF, lower, upper, true, true);

    } else {

      BooleanQuery tmp = new BooleanQuery();

      //TODO: Handle distance measures, as this assumes Euclidean

      double [] ur = DistanceUtils.vectorBoxCorner(point, null, options.distance, true);

      double [] ll = DistanceUtils.vectorBoxCorner(point, null, options.distance, false);

      for (int i = 0; i < ur.length; i++) {

        SchemaField subSF = subField(options.field, i);

        Query range = subSF.getType().getRangeQuery(parser, subSF, String.valueOf(ll[i]), String.valueOf(ur[i]), true, true);

        tmp.add(range, BooleanClause.Occur.MUST);

      }

      result = tmp;

    }

    return result;

  }

}

  private final SchemaField sf;

 

  public PointTypeValueSource(SchemaField sf, List<ValueSource> sources) {

    super(sources);

    this.sf = sf;

  }

  @Override

  public String name() {

    return "point";

  }

  @Override

  public String description() {

    return name()+"("+sf.getName()+")";

  }

}