org.gvsig.raster.wms.app.wmsclient.wmc

Class WebMapContext

java.lang.Object

org.gvsig.raster.wms.app.wmsclient.wmc.WebMapContext

public class WebMapContext
extends java.lang.Object

Class that loads and produces WebMapContext files and holds its attributes. You can create a blank WebMapContext instance using the default constructor or an already initialized instance by specifying a source file. In the last case the file will be readed and the values loaded an holded by the instance. You can get the equivalent WebMapContext XML document by calling the method getXML() supplying the ProjectView that you want to export and depending on the value of the fileVersion field (currently you can use "1.1.0" (default), "1.0.0" or "0.4.1" to specify the destination document version.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_abstract
java.lang.String	address
java.awt.geom.Rectangle2D	bBox
java.lang.String	city
boolean	contactInfo
java.lang.String	contactOrganization
java.lang.String	contactPerson
java.lang.String	contactPosition
java.lang.String	country
java.lang.String	descriptionURL
java.lang.String	descriptionURLFormat
java.lang.String	email
static java.util.ArrayList<java.lang.String>	exportVersions
java.lang.String	fax
static java.lang.String	FILE_EXTENSION
java.lang.String	fileVersion
java.lang.String	id
java.util.List<java.lang.String>	keywordList
java.lang.String	logoURL
java.lang.String	logoURLFormat
java.awt.Dimension	logoURLSize
java.lang.String	postCode
java.lang.String	srs
java.lang.String	stateOrProvince
java.lang.String	telephone
java.lang.String	title
java.awt.Dimension	windowSize
java.lang.String	xmlns
java.lang.String	xmlns_xlink
java.lang.String	xmlns_xsi
java.lang.String	xsi_schemaLocation

Constructor Summary

Constructors

Constructor and Description
WebMapContext()

Method Summary

Modifier and Type	Method and Description
static boolean	containsExportableLayers(FLayer layer) Searches in the layer tree of the TOC for an ocurrence of any exportable layer and returns true if so, or false otherwise.
static java.util.ArrayList	getExportableLayers(DefaultViewDocument v)
void	readFile(java.io.File file) Initializes the WebMapContext properties from the values in the WebMapContext (.cml) file passed in the argument.
java.lang.String	toXML(DefaultViewDocument v) Exports the ProjectView passed as parameter to Web Map Context XML compliant with the defined specifications for the version set in the fileVersion field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION

See Also:

Constant Field Values

exportVersions

public static final java.util.ArrayList<java.lang.String> exportVersions

fileVersion

public java.lang.String fileVersion

windowSize

public java.awt.Dimension windowSize

srs

public java.lang.String srs

bBox

public java.awt.geom.Rectangle2D bBox

title

public java.lang.String title

id

public java.lang.String id

xmlns

public java.lang.String xmlns

xmlns_xlink

public java.lang.String xmlns_xlink

xmlns_xsi

public java.lang.String xmlns_xsi

xsi_schemaLocation

public java.lang.String xsi_schemaLocation

_abstract

public java.lang.String _abstract

keywordList

public java.util.List<java.lang.String> keywordList

logoURLSize

public java.awt.Dimension logoURLSize

logoURLFormat

public java.lang.String logoURLFormat

logoURL

public java.lang.String logoURL

descriptionURLFormat

public java.lang.String descriptionURLFormat

descriptionURL

public java.lang.String descriptionURL

contactInfo

public boolean contactInfo

contactPerson

public java.lang.String contactPerson

contactOrganization

public java.lang.String contactOrganization

contactPosition

public java.lang.String contactPosition

address

public java.lang.String address

city

public java.lang.String city

stateOrProvince

public java.lang.String stateOrProvince

postCode

public java.lang.String postCode

country

public java.lang.String country

telephone

public java.lang.String telephone

fax

public java.lang.String fax

email

public java.lang.String email

Constructor Detail

WebMapContext

public WebMapContext()

Method Detail

readFile

public void readFile(java.io.File file)
              throws UnsupportedVersionLayerException,
                     ImportMapContextException

Initializes the WebMapContext properties from the values in the WebMapContext (.cml) file passed in the argument.

Parameters:

file -

Throws:

UnsupportedVersionLayerException

ImportMapContextException

toXML

public java.lang.String toXML(DefaultViewDocument v)

Exports the ProjectView passed as parameter to Web Map Context XML compliant with the defined specifications for the version set in the fileVersion field.

Parameters:

DefaultViewDocument - to be exported

Returns:

String containing the XML

getExportableLayers

public static java.util.ArrayList getExportableLayers(DefaultViewDocument v)

containsExportableLayers

public static boolean containsExportableLayers(FLayer layer)

Searches in the layer tree of the TOC for an ocurrence of any exportable layer and returns true if so, or false otherwise.

Parameters:

layer -

Returns: