org.geotools.data.ALLQuery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-main Show documentation

The main module contains the GeoTools public interfaces that are used by other GeoTools modules (and GeoTools applications). Where possible we make use industry standard terms as provided by OGC and ISO standards. The formal GeoTools public api consists of gt-metadata, jts and the gt-main module. The main module contains the default implementations that are available provided to other GeoTools modules using our factory system. Factories are obtained from an appropriate FactoryFinder, giving applications a chance configure the factory used using the Factory Hints facilities. FilterFactory ff = CommonFactoryFinder.getFilterFactory(); Expression expr = ff.add( expression1, expression2 ); If you find yourself using implementation specific classes chances are you doing it wrong: Expression expr = new AddImpl( expression1, expressiom2 );

The newest version!

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2008, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotools.data;

import java.net.URI;
import java.util.Arrays;
import java.util.List;
import org.geotools.util.factory.Hints;
import org.opengis.filter.Filter;
import org.opengis.filter.sort.SortBy;
import org.opengis.referencing.crs.CoordinateReferenceSystem;

/**
 * Implementation of Query.ALL.
 *
 * This query is used to retrive all Features. Query.ALL is the only instance of this class.
 *
 * 
Example:
 *
 * 

 * featureSource.getFeatures( Query.FIDS );
 * 
 */
class ALLQuery extends Query {
    public final String[] getPropertyNames() {
        return null;
    }

    public final boolean retrieveAllProperties() {
        return true;
    }

    public final int getMaxFeatures() {
        return DEFAULT_MAX; // consider Integer.MAX_VALUE
    }

    public Integer getStartIndex() {
        return null;
    }

    public final Filter getFilter() {
        return Filter.INCLUDE;
    }

    public final String getTypeName() {
        return null;
    }

    public URI getNamespace() {
        return NO_NAMESPACE;
    }

    public final String getHandle() {
        return "Request All Features";
    }

    public final String getVersion() {
        return null;
    }

    /**
     * Hashcode based on propertyName, maxFeatures and filter.
     *
     * @return hascode for filter
     */
    public int hashCode() {
        String[] n = getPropertyNames();

        return ((n == null) ? (-1) : ((n.length == 0) ? 0 : (n.length | n[0].hashCode())))
                | getMaxFeatures()
                | ((getFilter() == null) ? 0 : getFilter().hashCode())
                | ((getTypeName() == null) ? 0 : getTypeName().hashCode())
                | ((getVersion() == null) ? 0 : getVersion().hashCode())
                | ((getCoordinateSystem() == null) ? 0 : getCoordinateSystem().hashCode())
                | ((getCoordinateSystemReproject() == null)
                        ? 0
                        : getCoordinateSystemReproject().hashCode());
    }

    /**
     * Equality based on propertyNames, maxFeatures, filter, typeName and version.
     *
     * Changing the handle does not change the meaning of the Query.
     *
     * @param obj Other object to compare against
     * @return true if obj matches this filter
     */
    public boolean equals(Object obj) {
        if ((obj == null) || !(obj instanceof Query)) {
            return false;
        }

        if (this == obj) {
            return true;
        }

        Query other = (Query) obj;

        return Arrays.equals(getPropertyNames(), other.getPropertyNames())
                && (retrieveAllProperties() == other.retrieveAllProperties())
                && (getMaxFeatures() == other.getMaxFeatures())
                && ((getFilter() == null)
                        ? (other.getFilter() == null)
                        : getFilter().equals(other.getFilter()))
                && ((getTypeName() == null)
                        ? (other.getTypeName() == null)
                        : getTypeName().equals(other.getTypeName()))
                && ((getVersion() == null)
                        ? (other.getVersion() == null)
                        : getVersion().equals(other.getVersion()))
                && ((getCoordinateSystem() == null)
                        ? (other.getCoordinateSystem() == null)
                        : getCoordinateSystem().equals(other.getCoordinateSystem()))
                && ((getCoordinateSystemReproject() == null)
                        ? (other.getCoordinateSystemReproject() == null)
                        : getCoordinateSystemReproject()
                                .equals(other.getCoordinateSystemReproject()));
    }

    public String toString() {
        return "Query.ALL";
    }

    /**
     * Return null as ALLQuery does not require a CS.
     *
     * @return null as override is not required.
     * @see org.geotools.data.Query#getCoordinateSystem()
     */
    public CoordinateReferenceSystem getCoordinateSystem() {
        return null;
    }

    /**
     * Return null as ALLQuery does not require a CS.
     *
     * @return null as reprojection is not required.
     * @see org.geotools.data.Query#getCoordinateSystemReproject()
     */
    public CoordinateReferenceSystem getCoordinateSystemReproject() {
        return null;
    }

    /** @return {@link SortBy#UNSORTED}. */
    public SortBy[] getSortBy() {
        return SortBy.UNSORTED;
    }

    /** Returns an empty Hints set */
    public Hints getHints() {
        return new Hints();
    }

    //
    // Not mutable; all values hard coded
    //
    @Override
    public void setCoordinateSystem(CoordinateReferenceSystem system) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setCoordinateSystemReproject(CoordinateReferenceSystem system) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setFilter(Filter filter) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setHandle(String handle) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setHints(Hints hints) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setMaxFeatures(int maxFeatures) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setNamespace(URI namespace) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setPropertyNames(List propNames) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setPropertyNames(String[] propNames) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setSortBy(SortBy[] sortBy) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setStartIndex(Integer startIndex) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setTypeName(String typeName) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }

    @Override
    public void setVersion(String version) {
        throw new UnsupportedOperationException(
                "Query.ALL cannot be changed, please just use as a default.");
    }
}