com.metamx.collections.spatial.search.Bound Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bytebuffer-collections Show documentation

ByteBuffer Collections

The newest version!

/*
 * Copyright 2011 - 2015 Metamarkets Group Inc.
 *
 * Licensed 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 com.metamx.collections.spatial.search;

import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.metamx.collections.spatial.ImmutableNode;
import com.metamx.collections.spatial.ImmutablePoint;

/**
 */
@JsonTypeInfo(use=JsonTypeInfo.Id.NAME, property="type")
@JsonSubTypes(value={
    @JsonSubTypes.Type(name="rectangular", value=RectangularBound.class),
    @JsonSubTypes.Type(name="radius", value=RadiusBound.class),
    @JsonSubTypes.Type(name="polygon", value=PolygonBound.class)
})
public interface Bound
{
  public int getLimit();

  public int getNumDims();

  public boolean overlaps(ImmutableNode node);

  public boolean contains(float[] coords);

  public Iterable filter(Iterable points);

  public byte[] getCacheKey();
}