org.geotools.catalog.wms
Class WMSGeoResource

java.lang.Object
  org.geotools.catalog.AbstractGeoResource
      org.geotools.catalog.wms.WMSGeoResource

All Implemented Interfaces:

GeoResource, Resolve

public class WMSGeoResource

extends AbstractGeoResource

FeatureType provided by WFS.

Since:

0.6

Author:

David Zwiers, Refractions Research, Justin Deoliveira, The Open Planning Project

Nested Class Summary

Nested classes inherited from class org.geotools.catalog.Resolve

Resolve.Status

Constructor Summary

WMSGeoResource(WMSService parent, Layer layer)
Construct WMSGeoResourceImpl.

Method Summary

boolean	canResolve(java.lang.Class adaptee) Non blocking method which is used to determine if a resolve into an instance of a particular class is supported.
java.net.URI	getIdentifier() Returns a URI which uniqley identifies the Resolve.
GeoResourceInfo	getInfo(ProgressListener monitor) Blocking operation to describe this service.
java.lang.Throwable	getMessage() In the event that an error occurs during a resolve, that error can be reported back with this method.
Resolve.Status	getStatus() Status of the resolve.
Resolve	parent(ProgressListener monitor) This method is shorthand for return (Service) resolve(Service.class, monitor);
java.lang.Object	resolve(java.lang.Class adaptee, ProgressListener monitor) Blocking operation to resolve into the adaptee, if available.

Methods inherited from class org.geotools.catalog.AbstractGeoResource

addListener, equals, fire, hashCode, members, removeListener, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WMSGeoResource

public WMSGeoResource(WMSService parent,
                      Layer layer)

Construct WMSGeoResourceImpl.

Parameters:

parent -

layer -

Method Detail

parent

public Resolve parent(ProgressListener monitor)
               throws java.io.IOException

Description copied from class: AbstractGeoResource

This method is shorthand for

 	
 		return (Service) resolve(Service.class, monitor);
 	
 

Specified by:

parent in interface Resolve

Overrides:

parent in class AbstractGeoResource

Parameters:

monitor - DOCUMENT ME!

Returns:

The service containg the resource, an object of type Service.

Throws:

java.io.IOException - DOCUMENT ME!

See Also:

GeoResource.resolve(Class, ProgressListener)

getStatus

public Resolve.Status getStatus()

Description copied from interface: Resolve

Status of the resolve. Resolving into other types of objects often involves connecting to a remote service or resource. This method is provided to indicate the state of any connections.

Returns:

One of Resolve.Status.BROKEN,Resolve.Status.CONNECTED, or Resolve.Status.NOTCONNECTED.

getInfo

public GeoResourceInfo getInfo(ProgressListener monitor)
                        throws java.io.IOException

Description copied from interface: GeoResource

Blocking operation to describe this service.

As an example this method is used by LabelDecorators to aquire title, and icon.

Parameters:

monitor - DOCUMENT ME!

Returns:

IGeoResourceInfo resolve(IGeoResourceInfo.class,ProgressListener monitor);

Throws:

java.io.IOException - DOCUMENT ME!

See Also:

GeoResource.resolve(Class, ProgressListener)

getIdentifier

public java.net.URI getIdentifier()

Description copied from interface: Resolve

Returns a URI which uniqley identifies the Resolve.

Returns:

Id of the Resolve, should never be null.

resolve

public java.lang.Object resolve(java.lang.Class adaptee,
                                ProgressListener monitor)
                         throws java.io.IOException

Description copied from interface: GeoResource

Blocking operation to resolve into the adaptee, if available.

Required adaptions:

• IGeoResourceInfo.class
• IService.class

Example (no casting required):

 IGeoResourceInfo info = resovle(IGeoResourceInfo.class);
 

Recommendated adaptions:

• ImageDescriptor.class (for icon provided by external service)

Parameters:

adaptee -

monitor -

Returns:

instance of adaptee, or null if unavailable (IGeoResourceInfo and IService must be supported)

Throws:

java.io.IOException - DOCUMENT ME!

See Also:

GeoResourceInfo, IService, IResolve#resolve(Class, ProgressListener)

canResolve

public boolean canResolve(java.lang.Class adaptee)

Description copied from interface: Resolve

Non blocking method which is used to determine if a resolve into an instance of a particular class is supported.

Parameters:

adaptee - Class of object to resolve into.

Returns:

true if a resolution for adaptee is avaialble

See Also:

IResolve#resolve(Class,ProgressListener)

getMessage

public java.lang.Throwable getMessage()

Description copied from interface: Resolve

In the event that an error occurs during a resolve, that error can be reported back with this method. This method returns a value when Resolve.getStatus() returns Resolve.Status.BROKEN, otherwise it return null.

Returns:

An exception that occured during a resolve, otherwise null.

See Also:

Resolve.Status