org.geotools.styling
Interface ExternalGraphic

All Superinterfaces:
Symbol
All Known Implementing Classes:
ExternalGraphicImpl

public interface ExternalGraphic
extends Symbol

Holds a reference to an external graphics file with a URL to its location and its expected MIME type. Knowing the MIME type in advance allows stylers to select best-supported formats from a list of external graphics.

The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 01-077) version 0.7.2. Renderers can use this information when displaying styled features, though it must be remembered that not all renderers will be able to fully represent strokes as set out by this interface. For example, opacity may not be supported.

Version:
$Id: ExternalGraphic.java,v 1.11 2004/04/08 13:27:07 jfc173 Exp $
Author:
James Macgill, CCG

Method Summary
 java.util.Map getCustomProperties()
           
 java.lang.String getFormat()
          Provides the format of the external graphic.
 java.net.URL getLocation()
          Provides the URL for where the external graphic resource can be located.
 void setCustomProperties(java.util.Map list)
           
 void setFormat(java.lang.String format)
          Provides the format of the external graphic.
 void setLocation(java.net.URL url)
          Provides the URL for where the external graphic resource can be located.
 void setURI(java.lang.String uri)
          converts a URI in a string to the location URL
 
Methods inherited from interface org.geotools.styling.Symbol
accept
 

Method Detail

setURI

public void setURI(java.lang.String uri)
converts a URI in a string to the location URL

Parameters:
uri - the uri of the external graphic

getLocation

public java.net.URL getLocation()
                         throws java.net.MalformedURLException
Provides the URL for where the external graphic resource can be located.

Returns:
The URL of the ExternalGraphic
Throws:
java.net.MalformedURLException - If the url held in the ExternalGraphic is malformed.

setLocation

public void setLocation(java.net.URL url)
Provides the URL for where the external graphic resource can be located.

Parameters:
url - The URL of the ExternalGraphic

getFormat

public java.lang.String getFormat()
Provides the format of the external graphic.

Returns:
The format of the external graphic. Reported as its MIME type in a String object.

setFormat

public void setFormat(java.lang.String format)
Provides the format of the external graphic.

Parameters:
format - The format of the external graphic. Reported as its MIME type in a String object.

setCustomProperties

public void setCustomProperties(java.util.Map list)

getCustomProperties

public java.util.Map getCustomProperties()


Copyright © GeoTools. All Rights Reserved.