org.geotools.data.ResourceInfo 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 );

There is a newer version: 24.2-oss84-1

Show newest version

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2005-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.Set;
import org.geotools.geometry.jts.ReferencedEnvelope;
import org.opengis.referencing.crs.CoordinateReferenceSystem;

/**
 * This interface defines methods to convey information about some resource such as title, keywords,
 * description and spatial parameters.
 *
 * It is based on Dublin Core (a metadata specification initiative; http://dublincore.org/) and
 * the RDF application profile.
 *
 * 
There are two ids that may be associated with a resource:
 *
 * 

 *   name - unqiue within the context of a Service
 *   
schema - used to identify the type of resource
 * 
 *
 * @author Jody Garnett, Refractions Research
 * @author David Zwiers, Refractions Research
 * @author Justin Deoliveira, The Open Planning Project
 * @since 2.5
 */
public interface ResourceInfo {
    /**
     * Returns the resource's title.
     *
     * The title is human readable text representing the resource, in the current locale if
     * available.
     *
     * 

     *
     * @return tile, in the current locale if available.
     */
    String getTitle();

    /**
     * Returns keywords associated with this resource for use with searches etc.
     *
     * 
Known Mappings:
     *
     * 

     *   Maps to Dublin Core's Subject element
     * 
     *
     * @return Keywords or {@code null} if unavailable
     */
    Set getKeywords();

    /**
     * Returns a description or abstract for this resource.
     *
     * Known Mappings:
     *
     * 

     *   WFS GetCapabilities abstract
     *   
WMS GetCapabilities abstract
     * 
     *
     * The description may be in the current locale if known.
     *
     * @return description of resource, or null if unavailable
     */
    String getDescription();

    /**
     * Returns the name of this resource within the context of its service.
     *
     * Known mappings:
     *
     * 

     *   WFS typeName
     *   
Database table name
     *   
WMS layer name
     *   
level of a grid coverage
     * 
     *
     * The name should be unique within the context of a single Service.
     *
     * @return name of this resource
     */
    String getName();

    /**
     * A namespace, in the form of a {@code URI}, used to identify the resource type.
     *
     * Known Mappings:
     *
     * 

     *   Dublin Code Format element
     *   
WFS DescribeFeatureType URL
     *   
file.toURI()
     *   
XML namespace
     *   
URL
     * 
     *
     * @return namespace, used with getName() to identify resource type
     */
    URI getSchema();

    /**
     * Returns the bounds of the resource, expressed in the native coordinate reference system. IF
     * the bounds are unknown or undefined calling {@code isNull()} on the returned envelope will
     * return {@code true}.
     *
     * @return bounds of the resource if defined; otherwise an envelope where the {@code isNull()}
     *     returns {@code true}
     */
    ReferencedEnvelope getBounds();

    /**
     * Returns the coordinate reference system of this resource if known.
     *
     * Known Mappings:
     *
     * 

     *   2nd part of the Dublin Core Coverage
     *   
Shapefile prj file
     *   
WFS SRS
     * 
     *
     * @return CRS of the resource, or {@code null} if unavailable.
     */
    CoordinateReferenceSystem getCRS();

    /*
     * mbedward : removed from javadocs
     *
     * This method was considered because some services maintain this
     * information as metadata. If it was a bit more common (and axis order more consistent)
     * it would be worth considering.
     * 
     * Known Mappings:
     * 

     * 1st part of the Dublin Core Coverage
     * 
wfs LatLongBbox
     * 
     * 
     */
    // ReferencedEnvelope getLatLongBbox();
}