Package org.geotools.api.data

Interface ResourceInfo

All Known Subinterfaces:
FeatureTypeInfo, FileResourceInfo
All Known Implementing Classes:
DefaultFileResourceInfo, DefaultResourceInfo, FeatureTypeInfoImpl, FeatureTypeInfoImpl, GDALResourceInfo, ImageMosaicFileResourceInfo, WebMapServer.LayerInfo
public interface ResourceInfo
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
Since:
2.5
Author:
Jody Garnett, Refractions Research, David Zwiers, Refractions Research, Justin Deoliveira, The Open Planning Project

  • Method Summary

    Modifier and Type
    Method
    Description
    ReferencedEnvelope
    getBounds()
    Returns the bounds of the resource, expressed in the native coordinate reference system.
    CoordinateReferenceSystem
    getCRS()
    Returns the coordinate reference system of this resource if known.
    String
    getDescription()
    Returns a description or abstract for this resource.
    Set<String>
    getKeywords()
    Returns keywords associated with this resource for use with searches etc.
    String
    getName()
    Returns the name of this resource within the context of its service.
    URI
    getSchema()
    A namespace, in the form of a URI, used to identify the resource type.
    String
    getTitle()
    Returns the resource's title.

  • Method Details

    • getTitle

      String getTitle()
      Returns the resource's title.

      The title is human readable text representing the resource, in the current locale if available.

      Returns:
      tile, in the current locale if available.

    • getKeywords

      Set<String> getKeywords()
      Returns keywords associated with this resource for use with searches etc.

      Known Mappings:

      • Maps to Dublin Core's Subject element
      Returns:
      Keywords or null if unavailable

    • getDescription

      String getDescription()
      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.
      Returns:
      description of resource, or null if unavailable

    • getName

      String getName()
      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.
      Returns:
      name of this resource

    • getSchema

      URI getSchema()
      A namespace, in the form of a URI, used to identify the resource type.

      Known Mappings:

      • Dublin Code Format element
      • WFS DescribeFeatureType URL
      • file.toURI()
      • XML namespace
      • URL
      Returns:
      namespace, used with getName() to identify resource type

    • getBounds

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

    • getCRS

      CoordinateReferenceSystem getCRS()
      Returns the coordinate reference system of this resource if known.

      Known Mappings:

      • 2nd part of the Dublin Core Coverage
      • Shapefile prj file
      • WFS SRS
      Returns:
      CRS of the resource, or null if unavailable.