deegree-core-3.0-pre-nightly (2010/03/05 00:01) - official

org.deegree.commons.datasource.configuration
Class WMSDataSourceType

java.lang.Object
  extended by org.deegree.commons.datasource.configuration.AbstractDataSourceType
      extended by org.deegree.commons.datasource.configuration.AbstractGeospatialDataSourceType
          extended by org.deegree.commons.datasource.configuration.AbstractWebBasedDataSourceType
              extended by org.deegree.commons.datasource.configuration.WMSDataSourceType

public class WMSDataSourceType
extends AbstractWebBasedDataSourceType

A WMS datasource defines the access to a 'remote' wms. For this purpose it holds information about the request type (GetMap, GetFeatureInfo) and the layers.

Java class for WMSDataSourceType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="WMSDataSourceType">
   <complexContent>
     <extension base="{http://www.deegree.org/datasource}AbstractWebBasedDataSourceType">
       <sequence>
         <element name="RequestedLayers" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="RequestedFormat" minOccurs="0">
           <complexType>
             <simpleContent>
               <extension base="<http://www.w3.org/2001/XMLSchema>string">
                 <attribute name="transparent" type="{http://www.w3.org/2001/XMLSchema}boolean" />
               </extension>
             </simpleContent>
           </complexType>
         </element>
         <element name="RequestTimeout" type="{http://www.w3.org/2001/XMLSchema}integer" minOccurs="0"/>
         <element name="MaxMapDimensions" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="width" type="{http://www.w3.org/2001/XMLSchema}integer" />
                 <attribute name="height" type="{http://www.w3.org/2001/XMLSchema}integer" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="DefaultSRS" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="RestrictedRequestParameter" type="{http://www.deegree.org/datasource}RestrictedRequestParameterType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 


Nested Class Summary
static class WMSDataSourceType.MaxMapDimensions
          Java class for anonymous complex type.
static class WMSDataSourceType.RequestedFormat
          Java class for anonymous complex type.
 
Nested classes/interfaces inherited from class org.deegree.commons.datasource.configuration.AbstractWebBasedDataSourceType
AbstractWebBasedDataSourceType.CapabilitiesDocumentLocation
 
Field Summary
protected  String defaultSRS
           
protected  WMSDataSourceType.MaxMapDimensions maxMapDimensions
           
protected  WMSDataSourceType.RequestedFormat requestedFormat
           
protected  String requestedLayers
           
protected  BigInteger requestTimeout
           
protected  List<RestrictedRequestParameterType> restrictedRequestParameter
           
 
Fields inherited from class org.deegree.commons.datasource.configuration.AbstractWebBasedDataSourceType
capabilitiesDocumentLocation
 
Fields inherited from class org.deegree.commons.datasource.configuration.AbstractGeospatialDataSourceType
bBoxConstraint, scaleConstraint
 
Fields inherited from class org.deegree.commons.datasource.configuration.AbstractDataSourceType
dataSourceName
 
Constructor Summary
WMSDataSourceType()
           
 
Method Summary
 String getDefaultSRS()
          Gets the value of the defaultSRS property.
 WMSDataSourceType.MaxMapDimensions getMaxMapDimensions()
          Gets the value of the maxMapDimensions property.
 WMSDataSourceType.RequestedFormat getRequestedFormat()
          Gets the value of the requestedFormat property.
 String getRequestedLayers()
          Gets the value of the requestedLayers property.
 BigInteger getRequestTimeout()
          Gets the value of the requestTimeout property.
 List<RestrictedRequestParameterType> getRestrictedRequestParameter()
          Gets the value of the restrictedRequestParameter property.
 void setDefaultSRS(String value)
          Sets the value of the defaultSRS property.
 void setMaxMapDimensions(WMSDataSourceType.MaxMapDimensions value)
          Sets the value of the maxMapDimensions property.
 void setRequestedFormat(WMSDataSourceType.RequestedFormat value)
          Sets the value of the requestedFormat property.
 void setRequestedLayers(String value)
          Sets the value of the requestedLayers property.
 void setRequestTimeout(BigInteger value)
          Sets the value of the requestTimeout property.
 
Methods inherited from class org.deegree.commons.datasource.configuration.AbstractWebBasedDataSourceType
getCapabilitiesDocumentLocation, setCapabilitiesDocumentLocation
 
Methods inherited from class org.deegree.commons.datasource.configuration.AbstractGeospatialDataSourceType
getBBoxConstraint, getScaleConstraint, setBBoxConstraint, setScaleConstraint
 
Methods inherited from class org.deegree.commons.datasource.configuration.AbstractDataSourceType
getDataSourceName, setDataSourceName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

requestedLayers

protected String requestedLayers

requestedFormat

protected WMSDataSourceType.RequestedFormat requestedFormat

requestTimeout

protected BigInteger requestTimeout

maxMapDimensions

protected WMSDataSourceType.MaxMapDimensions maxMapDimensions

defaultSRS

protected String defaultSRS

restrictedRequestParameter

protected List<RestrictedRequestParameterType> restrictedRequestParameter
Constructor Detail

WMSDataSourceType

public WMSDataSourceType()
Method Detail

getRequestedLayers

public String getRequestedLayers()
Gets the value of the requestedLayers property.

Returns:
possible object is String

setRequestedLayers

public void setRequestedLayers(String value)
Sets the value of the requestedLayers property.

Parameters:
value - allowed object is String

getRequestedFormat

public WMSDataSourceType.RequestedFormat getRequestedFormat()
Gets the value of the requestedFormat property.

Returns:
possible object is WMSDataSourceType.RequestedFormat

setRequestedFormat

public void setRequestedFormat(WMSDataSourceType.RequestedFormat value)
Sets the value of the requestedFormat property.

Parameters:
value - allowed object is WMSDataSourceType.RequestedFormat

getRequestTimeout

public BigInteger getRequestTimeout()
Gets the value of the requestTimeout property.

Returns:
possible object is BigInteger

setRequestTimeout

public void setRequestTimeout(BigInteger value)
Sets the value of the requestTimeout property.

Parameters:
value - allowed object is BigInteger

getMaxMapDimensions

public WMSDataSourceType.MaxMapDimensions getMaxMapDimensions()
Gets the value of the maxMapDimensions property.

Returns:
possible object is WMSDataSourceType.MaxMapDimensions

setMaxMapDimensions

public void setMaxMapDimensions(WMSDataSourceType.MaxMapDimensions value)
Sets the value of the maxMapDimensions property.

Parameters:
value - allowed object is WMSDataSourceType.MaxMapDimensions

getDefaultSRS

public String getDefaultSRS()
Gets the value of the defaultSRS property.

Returns:
possible object is String

setDefaultSRS

public void setDefaultSRS(String value)
Sets the value of the defaultSRS property.

Parameters:
value - allowed object is String

getRestrictedRequestParameter

public List<RestrictedRequestParameterType> getRestrictedRequestParameter()
Gets the value of the restrictedRequestParameter property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the restrictedRequestParameter property.

For example, to add a new item, do as follows:

    getRestrictedRequestParameter().add(newItem);
 

Objects of the following type(s) are allowed in the list RestrictedRequestParameterType


deegree-core-3.0-pre-nightly (2010/03/05 00:01) - official

an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://www.deegree.org

]]>