WebMapContext

java.lang.Object
- org.gvsig.raster.wms.app.wmsclient.wmc.WebMapContext

```
public class WebMapContext
extends 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
`String`	`_abstract`
`String`	`address`
`Rectangle2D`	`bBox`
`String`	`city`
`boolean`	`contactInfo`
`String`	`contactOrganization`
`String`	`contactPerson`
`String`	`contactPosition`
`String`	`country`
`String`	`descriptionURL`
`String`	`descriptionURLFormat`
`String`	`email`
`static ArrayList<String>`	`exportVersions`
`String`	`fax`
`static String`	`FILE_EXTENSION`
`String`	`fileVersion`
`String`	`id`
`List<String>`	`keywordList`
`String`	`logoURL`
`String`	`logoURLFormat`
`Dimension`	`logoURLSize`
`String`	`postCode`
`String`	`srs`
`String`	`stateOrProvince`
`String`	`telephone`
`String`	`title`
`Dimension`	`windowSize`
`String`	`xmlns`
`String`	`xmlns_xlink`
`String`	`xmlns_xsi`
`String`	`xsi_schemaLocation`

Constructor Summary

Constructors
Constructor and Description

WebMapContext()

Constructors
Constructor and Description
`WebMapContext()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 ArrayList`	`getExportableLayers(DefaultViewDocument v)`
`void`	`readFile(File file)` Initializes the WebMapContext properties from the values in the WebMapContext (.cml) file passed in the argument.
`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 String FILE_EXTENSION

See Also:: Constant Field Values

exportVersions

public static final ArrayList<String> exportVersions

fileVersion
```
public String fileVersion
```

windowSize
```
public Dimension windowSize
```

srs
```
public String srs
```

bBox
```
public Rectangle2D bBox
```

title
```
public String title
```

id
```
public String id
```

xmlns
```
public String xmlns
```

xmlns_xlink
```
public String xmlns_xlink
```

xmlns_xsi
```
public String xmlns_xsi
```

xsi_schemaLocation
```
public String xsi_schemaLocation
```

_abstract
```
public String _abstract
```

keywordList
```
public List<String> keywordList
```

logoURLSize
```
public Dimension logoURLSize
```

logoURLFormat
```
public String logoURLFormat
```

logoURL
```
public String logoURL
```

descriptionURLFormat
```
public String descriptionURLFormat
```

descriptionURL
```
public String descriptionURL
```

contactInfo
```
public boolean contactInfo
```

contactPerson
```
public String contactPerson
```

contactOrganization
```
public String contactOrganization
```

contactPosition
```
public String contactPosition
```

address
```
public String address
```

city
```
public String city
```

stateOrProvince
```
public String stateOrProvince
```

postCode
```
public String postCode
```

country
```
public String country
```

telephone
```
public String telephone
```

fax
```
public String fax
```

email
```
public String email
```

Constructor Detail
- WebMapContext
```
public WebMapContext()
```

Method Detail
- readFile
```
public void readFile(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 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 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:

Class WebMapContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILE_EXTENSION

exportVersions

fileVersion

windowSize

srs

bBox

title

id

xmlns

xmlns_xlink

xmlns_xsi

xsi_schemaLocation

_abstract

keywordList

logoURLSize

logoURLFormat

logoURL

descriptionURLFormat

descriptionURL

contactInfo

contactPerson

contactOrganization

contactPosition

address

city

stateOrProvince

postCode

country

telephone

fax

email

Constructor Detail

WebMapContext

Method Detail

readFile

toXML

getExportableLayers

containsExportableLayers