Layer (b3p-commons-gis 4.2.9 API)

java.lang.Object
- nl.b3p.wms.capabilities.Layer

All Implemented Interfaces:: Comparable, XMLElement

public class Layer
extends Object
implements XMLElement, Comparable

Constructor Summary

Constructors
Constructor and Description

Layer()

Constructors
Constructor and Description
`Layer()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDimension(Dimensions dimension)`
`void`	`addDomainResource(LayerDomainResource dr)`
`void`	`addIdentifier(Identifier identifier)`
`void`	`addKeyword(String keyword)`
`void`	`addLayer(Layer layer)`
`void`	`addSrsbb(SrsBoundingBox s)`
`void`	`addStyle(Style style)`
`Set`	`buildLayerSet(Set layerset, ServiceProvider serviceProvider)`
`Layer`	`buildLayerTree(Set layerset)`
`Object`	`clone()` Method that will create a deep copy of this object.
`int`	`compareTo(Object o)`
`protected void`	`convertValues2KB(HashMap conversionValues)` Method that will overwrite the URL's stored in the database with the URL specified for Kaartenbalie.
`boolean`	`equals(Layer layer)` Public method to check wether the given layer as parameter equals this layer.
`boolean`	`equals(Object o)`
`String`	`getAbstracts()`
`Attribution`	`getAttribution()`
`Set`	`getAuthSubLayersClone(Set authLayerIds)`
`String`	`getCascaded()`
`String`	`getCompleteTitle()`
`Set`	`getDimensions()`
`Set`	`getDomainResource()`
`String`	`getFixedHeight()`
`String`	`getFixedWidth()`
`Integer`	`getId()`
`Set`	`getIdentifiers()`
`Map`	`getIdentityMap(boolean includeServiceProviderAbbr)` Get a map of tuples containing the identity of this layer, for purposes of comparing the identity maps of different layers.
`Set`	`getKeywordList()`
`Set`	`getLayerMetadata()`
`Set`	`getLayers()`
`String`	`getMetadata()`
`String`	`getName()`
`String`	`getNosubsets()`
`String`	`getOpaque()`
`Set`	`getOrganizationLayers()`
`Layer`	`getParent()`
`String`	`getQueryable()`
`String`	`getScaleHintMax()`
`String`	`getScaleHintMin()`
`ServiceProvider`	`getServiceProvider()`
`String`	`getSpAbbr()`
`Set`	`getSrsbb()`
`Set<Style>`	`getStyles()`
`String`	`getTitle()`
`Layer`	`getTopLayer()`
`String`	`getUniqueName()`
`int`	`hashCode()`
`boolean`	`inList(Set layers)` Public method which checks if this layer is in a list with layers given as a parameter.
`void`	`setAbstracts(String abstracts)`
`void`	`setAttribution(Attribution attribution)`
`void`	`setCascaded(String cascaded)`
`void`	`setDimensions(Set dimensions)`
`void`	`setDomainResource(Set domainResource)`
`void`	`setFixedHeight(String fixedHeight)`
`void`	`setFixedWidth(String fixedWidth)`
`protected void`	`setId(Integer id)`
`void`	`setIdentifiers(Set identifiers)`
`void`	`setKeywordList(Set keywordList)`
`void`	`setLayerMetadata(Set layerMetadata)`
`void`	`setLayers(Set layers)`
`void`	`setMetadata(String metaData)`
`void`	`setName(String name)`
`void`	`setNosubsets(String nosubsets)`
`void`	`setOpaque(String opaque)`
`void`	`setOrganizationLayers(Set organizationLayers)`
`void`	`setParent(Layer parent)`
`void`	`setQueryable(String queryable)`
`void`	`setScaleHintMax(String scaleHintMax)`
`void`	`setScaleHintMin(String scaleHintMin)`
`void`	`setServiceProvider(ServiceProvider serviceProvider)`
`void`	`setSrsbb(Set srsbb)`
`void`	`setStyles(Set<Style> styles)`
`void`	`setTitle(String title)`
`Element`	`toElement(Document doc, Element rootElement)` Method that will create piece of the XML tree to create a proper XML docuement.
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- Layer
```
public Layer()
```

Method Detail

getId
```
public Integer getId()
```

setId
```
protected void setId(Integer id)
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getAbstracts
```
public String getAbstracts()
```

setAbstracts

public void setAbstracts(String abstracts)

getQueryable
```
public String getQueryable()
```

setQueryable

public void setQueryable(String queryable)

getCascaded
```
public String getCascaded()
```

setCascaded

public void setCascaded(String cascaded)

getOpaque
```
public String getOpaque()
```

setOpaque
```
public void setOpaque(String opaque)
```

getNosubsets
```
public String getNosubsets()
```

setNosubsets

public void setNosubsets(String nosubsets)

getFixedWidth
```
public String getFixedWidth()
```

setFixedWidth

public void setFixedWidth(String fixedWidth)

getFixedHeight
```
public String getFixedHeight()
```

setFixedHeight

public void setFixedHeight(String fixedHeight)

getScaleHintMin
```
public String getScaleHintMin()
```

setScaleHintMin

public void setScaleHintMin(String scaleHintMin)

getScaleHintMax
```
public String getScaleHintMax()
```

setScaleHintMax

public void setScaleHintMax(String scaleHintMax)

getParent
```
public Layer getParent()
```

setParent
```
public void setParent(Layer parent)
```

getServiceProvider

public ServiceProvider getServiceProvider()

setServiceProvider

public void setServiceProvider(ServiceProvider serviceProvider)

buildLayerSet

public Set buildLayerSet(Set layerset,
                ServiceProvider serviceProvider)
                  throws Exception

Throws:: Exception

getDimensions
```
public Set getDimensions()
```

setDimensions

public void setDimensions(Set dimensions)

addDimension

public void addDimension(Dimensions dimension)

getKeywordList
```
public Set getKeywordList()
```

setKeywordList

public void setKeywordList(Set keywordList)

addKeyword

public void addKeyword(String keyword)

getStyles
```
public Set<Style> getStyles()
```

setStyles

public void setStyles(Set<Style> styles)

addStyle
```
public void addStyle(Style style)
```

getDomainResource
```
public Set getDomainResource()
```

setDomainResource

public void setDomainResource(Set domainResource)

addDomainResource

public void addDomainResource(LayerDomainResource dr)

getIdentifiers
```
public Set getIdentifiers()
```

setIdentifiers

public void setIdentifiers(Set identifiers)

addIdentifier

public void addIdentifier(Identifier identifier)

getOrganizationLayers
```
public Set getOrganizationLayers()
```

setOrganizationLayers

public void setOrganizationLayers(Set organizationLayers)

getSrsbb
```
public Set getSrsbb()
```

setSrsbb
```
public void setSrsbb(Set srsbb)
```

addSrsbb

public void addSrsbb(SrsBoundingBox s)

getLayers
```
public Set getLayers()
```

setLayers
```
public void setLayers(Set layers)
```

addLayer

public void addLayer(Layer layer)
              throws Exception

Throws:: Exception

buildLayerTree

public Layer buildLayerTree(Set layerset)
                     throws Exception

Throws:: Exception

getAttribution
```
public Attribution getAttribution()
```

setAttribution

public void setAttribution(Attribution attribution)

getSpAbbr
```
public String getSpAbbr()
```

getUniqueName
```
public String getUniqueName()
```

getCompleteTitle
```
public String getCompleteTitle()
```

getMetadata
```
public String getMetadata()
```

setMetadata

public void setMetadata(String metaData)

getLayerMetadata
```
public Set getLayerMetadata()
```

setLayerMetadata

public void setLayerMetadata(Set layerMetadata)

getAuthSubLayersClone

public Set getAuthSubLayersClone(Set authLayerIds)

convertValues2KB
```
protected void convertValues2KB(HashMap conversionValues)
```
Method that will overwrite the URL's stored in the database with the URL specified for Kaartenbalie. This new URL indicate the link to the kaartenbalie, while the old link is used to indicate the URL to the real location of the service. Because the client which is connected to kaartenbalie has to send his requests back to kaartenbalie and not directly to the official resource, the URL has to be replaced.

Parameters:
newUrl - String representing the URL the old URL has to be replaced with.

clone
```
public Object clone()
```
Method that will create a deep copy of this object.

Overrides:

clone in class Object

Returns:
an object of type Object

toElement
```
public Element toElement(Document doc,
                Element rootElement)
```
Method that will create piece of the XML tree to create a proper XML docuement.

Specified by:

toElement in interface XMLElement

Parameters:
doc - Document object which is being used to create new Elements
rootElement - The element where this object belongs to.

Returns:
an object of type Element

getTopLayer
```
public Layer getTopLayer()
```

getIdentityMap
```
public Map getIdentityMap(boolean includeServiceProviderAbbr)
```
Get a map of tuples containing the identity of this layer, for purposes of comparing the identity maps of different layers. The includeServiceProviderAbbr can be used to create identity maps which do or do not include the service provider abbreviation. The properties which are always added to the map are getName(), getTitle() and getCascaded()

Parameters:
includeServiceProviderAbbr - if getServiceProvider().getAbbr() should be included in the map.

Returns:
A Map containing tuples of identifier properties

equals
```
public boolean equals(Layer layer)
```
Public method to check wether the given layer as parameter equals this layer.

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

inList
```
public boolean inList(Set layers)
```
Public method which checks if this layer is in a list with layers given as a parameter.

toString
```
public String toString()
```
Overrides:

toString in class Object

compareTo
```
public int compareTo(Object o)
```
Specified by:

compareTo in interface Comparable

Class Layer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Layer

Method Detail

getId

setId

getName

setName

getTitle

setTitle

getAbstracts

setAbstracts

getQueryable

setQueryable

getCascaded

setCascaded

getOpaque

setOpaque

getNosubsets

setNosubsets

getFixedWidth

setFixedWidth

getFixedHeight

setFixedHeight

getScaleHintMin

setScaleHintMin

getScaleHintMax

setScaleHintMax

getParent

setParent

getServiceProvider

setServiceProvider

buildLayerSet

getDimensions

setDimensions

addDimension

getKeywordList

setKeywordList

addKeyword

getStyles

setStyles

addStyle

getDomainResource

setDomainResource

addDomainResource

getIdentifiers

setIdentifiers

addIdentifier

getOrganizationLayers

setOrganizationLayers

getSrsbb

setSrsbb

addSrsbb

getLayers

setLayers

addLayer

buildLayerTree

getAttribution

setAttribution

getSpAbbr

getUniqueName

getCompleteTitle

getMetadata

setMetadata

getLayerMetadata

setLayerMetadata

getAuthSubLayersClone

convertValues2KB

clone

toElement

getTopLayer

getIdentityMap

equals

equals

hashCode

inList

toString