net.refractions.udig.catalog
Class IServiceInfo

java.lang.Object
  extended by net.refractions.udig.catalog.IServiceInfo

public class IServiceInfo
extends java.lang.Object

Provides metadata information about a service.

Information is provided in the form of a single, simple, Java bean. You can treat this bean as a "view" on more complete metadata information that may be accessable via a subclass (or other resolve target). This bean offers up service metadata information to the uDig search facilities, this information may also be displayed to users.

Much of the names and motivation have been taken from Dublin Code and it's application profile for RDF.

Since:
0.6
Author:
David Zwiers, Refractions Research

Field Summary
protected  java.lang.String _abstract
           
protected  java.lang.String description
           
protected  ImageDescriptor icon
           
protected  java.lang.String[] keywords
           
protected  java.net.URL publisher
           
protected  java.net.URI schema
           
protected  java.net.URL source
           
protected  java.lang.String title
           
 
Constructor Summary
protected IServiceInfo()
           
  IServiceInfo(java.lang.String title, java.lang.String description, java.lang.String _abstract, java.net.URL source, java.net.URL publisher, java.net.URI schema, java.lang.String[] keywords, ImageDescriptor icon)
           
 
Method Summary
 java.lang.String getAbstract()
          Return the service abstract.
 java.lang.String getDescription()
          Returns the service description.
 ImageDescriptor getIcon()
          Base symbology (with out decorators) representing this IService.
 java.lang.String[] getKeywords()
          Returns the service keywords.
 java.net.URL getPublisher()
          Return the service publisher
 java.net.URI getSchema()
          Returns the xml schema namespace for this service type.
 java.net.URL getSource()
          Returns the service source.
 java.lang.String getTitle()
          Returns the service title, may be empty or null if unsupported.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

title

protected java.lang.String title

description

protected java.lang.String description

_abstract

protected java.lang.String _abstract

schema

protected java.net.URI schema

source

protected java.net.URL source

publisher

protected java.net.URL publisher

keywords

protected java.lang.String[] keywords

icon

protected ImageDescriptor icon
Constructor Detail

IServiceInfo

protected IServiceInfo()

IServiceInfo

public IServiceInfo(java.lang.String title,
                    java.lang.String description,
                    java.lang.String _abstract,
                    java.net.URL source,
                    java.net.URL publisher,
                    java.net.URI schema,
                    java.lang.String[] keywords,
                    ImageDescriptor icon)
Method Detail

getTitle

public java.lang.String getTitle()
Returns the service title, may be empty or null if unsupported.

Note this is always metadata, and is in user terms.

Returns:
title, may be empty, null if unsupported.

getKeywords

public java.lang.String[] getKeywords()
Returns the service keywords. Maps to the Dublin Core Subject element.

Returns:

getDescription

public java.lang.String getDescription()
Returns the service description. This use is understood to be in agreement with "dublin-core", implementors may use either abstract or description as needed.

Dublin Core: A textual description of the content of the resource, including abstracts in the case of document-like objects or content descriptions in the case of visual resources. When providing actual dublin-core metadata you can gather up all the description information into a single string for searching.

Returns:
Description of visual contents

getAbstract

public java.lang.String getAbstract()
Return the service abstract. This use is understood to be in agreement with OGC Open Web Services, implementors may use either abstract or description as needed.

When working with an Open Web Service this method is a direct match, you may also choose it when providing actual dublin-core information if the description element is specifically an abstract.

Returns:
text Abstract of document-like services

getPublisher

public java.net.URL getPublisher()
Return the service publisher

Returns:

getSchema

public java.net.URI getSchema()
Returns the xml schema namespace for this service type.

Maps to the Dublin Code Format element.

Returns:
namespace for service type

getSource

public java.net.URL getSource()
Returns the service source. Maps to the Dublin Core Server Element

Returns:

getIcon

public ImageDescriptor getIcon()
Base symbology (with out decorators) representing this IService.

The ImageDescriptor returned should conform the the Eclipse User Interface Guidelines (16x16 image with a 16x15 glyph centered).

This plug-in provides default images based on service type:


  <b>return</b> ISharedImages.getImagesDescriptor( IService );