Layer (viewer-config-persistence 4.8.1.8 API)

java.lang.Object
- nl.b3p.viewer.config.services.Layer

All Implemented Interfaces:

Serializable, Cloneable
```
@Entity
public class Layer
extends Object
implements Cloneable, Serializable
```
Author:

Matthijs Laan

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Layer.Visitor

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Layer.Visitor`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DETAIL_ALL_CHILDREN` Layer.details map key for comma separated list of layer names of children of this layer.
`static String`	`DETAIL_ALTERNATE_LEGEND_IMAGE_URL`
`static String`	`DETAIL_WMS_STYLES` JSON representation of wms:Style elements from capabilities for this layer
`static String`	`EXTRA_IMAGE_EXTENSION`
`static String`	`EXTRA_KEY_ATTRIBUTION`
`static String`	`EXTRA_KEY_DOWNLOAD_URL`
`static String`	`EXTRA_KEY_FILTERABLE`
`static String`	`EXTRA_KEY_METADATA_STYLESHEET_URL`
`static String`	`EXTRA_KEY_METADATA_URL`
`Set<String>`	`preventGeomEditors`
`Set<String>`	`writers`

Constructor Summary

Constructors
Constructor and Description

Layer()

Layer(org.geotools.data.ows.Layer l, GeoService service)

Constructors
Constructor and Description
`Layer()`
`Layer(org.geotools.data.ows.Layer l, GeoService service)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(Layer.Visitor visitor, javax.persistence.EntityManager em)` Do a depth-first traversal while the visitor returns true.
`protected void`	`copyUserModifiedProperties(Layer other)` Copy user modified properties of given layer onto this instance.
`List<ApplicationLayer>`	`getApplicationLayers(javax.persistence.EntityManager em)`
`Map<CoordinateReferenceSystem,BoundingBox>`	`getBoundingBoxes()`
`List<Layer>`	`getCachedChildren(javax.persistence.EntityManager em)`
`List<Layer>`	`getChildren()`
`Set<CoordinateReferenceSystem>`	`getCrsList()`
`Map<String,ClobElement>`	`getDetails()`
`String`	`getDisplayName()`
`SimpleFeatureType`	`getFeatureType()`
`Long`	`getId()`
`Set<String>`	`getKeywords()`
`String`	`getLegendImageUrl()`
`List<TileMatrixSet>`	`getMatrixSets()`
`Double`	`getMaxScale()`
`Double`	`getMinScale()`
`String`	`getName()`
`Layer`	`getParent()`
`Set<String>`	`getPreventGeomEditors()`
`Set<String>`	`getReaders()`
`GeoService`	`getService()`
`TileSet`	`getTileset()`
`String`	`getTitle()`
`String`	`getTitleAlias()`
`Set<String>`	`getWriters()`
`boolean`	`isBufferable()` Checks if the layer is bufferable.
`boolean`	`isFilterable()`
`boolean`	`isQueryable()`
`boolean`	`isVirtual()`
`Layer`	`pluckCopy()` Clone this layer and remove it from the tree of the GeoService this Layer is part of.
`void`	`setBoundingBoxes(Map<CoordinateReferenceSystem,BoundingBox> boundingBoxes)`
`void`	`setChildren(List<Layer> children)`
`void`	`setCrsList(Set<CoordinateReferenceSystem> crsList)`
`void`	`setDetails(Map<String,ClobElement> details)`
`void`	`setFeatureType(SimpleFeatureType featureType)`
`void`	`setFilterable(boolean filterable)`
`void`	`setId(Long id)`
`void`	`setKeywords(Set<String> keywords)`
`void`	`setLegendImageUrl(String legendImageUrl)`
`void`	`setMatrixSets(List<TileMatrixSet> matrixSets)`
`void`	`setMaxScale(Double maxScale)`
`void`	`setMinScale(Double minScale)`
`void`	`setName(String name)`
`void`	`setParent(Layer parent)`
`void`	`setPreventGeomEditors(Set<String> preventGeomEditors)`
`void`	`setQueryable(boolean queryable)`
`void`	`setReaders(Set<String> readers)`
`void`	`setService(GeoService service)`
`void`	`setTileset(TileSet tileset)`
`void`	`setTitle(String title)`
`void`	`setTitleAlias(String titleAlias)`
`void`	`setVirtual(boolean virtual)`
`void`	`setWriters(Set<String> writers)`
`org.json.JSONObject`	`toJSONObject()`
`protected void`	`update(Layer update)`
`protected void`	`update(Layer update, Set<String> additionalUpdatableDetails)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- EXTRA_KEY_METADATA_URL
```
public static final String EXTRA_KEY_METADATA_URL
```
  See Also:
  
  Constant Field Values
- EXTRA_KEY_METADATA_STYLESHEET_URL
```
public static final String EXTRA_KEY_METADATA_STYLESHEET_URL
```
  See Also:
  
  Constant Field Values
- EXTRA_KEY_DOWNLOAD_URL
```
public static final String EXTRA_KEY_DOWNLOAD_URL
```
  See Also:
  
  Constant Field Values
- EXTRA_KEY_FILTERABLE
```
public static final String EXTRA_KEY_FILTERABLE
```
  See Also:
  
  Constant Field Values
- EXTRA_IMAGE_EXTENSION
```
public static final String EXTRA_IMAGE_EXTENSION
```
  See Also:
  
  Constant Field Values
- EXTRA_KEY_ATTRIBUTION
```
public static final String EXTRA_KEY_ATTRIBUTION
```
  See Also:
  
  Constant Field Values
- DETAIL_WMS_STYLES
```
public static final String DETAIL_WMS_STYLES
```
  JSON representation of wms:Style elements from capabilities for this layer
  
  See Also:
  
  Constant Field Values
- DETAIL_ALL_CHILDREN
```
public static final String DETAIL_ALL_CHILDREN
```
  Layer.details map key for comma separated list of layer names of children of this layer.
  
  See Also:
  
  Constant Field Values
- DETAIL_ALTERNATE_LEGEND_IMAGE_URL
```
public static final String DETAIL_ALTERNATE_LEGEND_IMAGE_URL
```
  See Also:
  
  Constant Field Values
- writers
```
public Set<String> writers
```
- preventGeomEditors
```
public Set<String> preventGeomEditors
```

Constructor Detail

Layer
```
public Layer()
```

Layer

public Layer(org.geotools.data.ows.Layer l,
             GeoService service)

Method Detail

update
```
protected void update(Layer update)
```

update

protected void update(Layer update,
                      Set<String> additionalUpdatableDetails)

copyUserModifiedProperties
```
protected void copyUserModifiedProperties(Layer other)
```
Copy user modified properties of given layer onto this instance. Used for updating the topLayer. Not called for other layers, those instances are updated with update().

Parameters:

other - the source of properties to copy

pluckCopy
```
public Layer pluckCopy()
```
Clone this layer and remove it from the tree of the GeoService this Layer is part of. Used for updating service, call only on non-persistent objects.

Returns:

a clone of this Layer with its parent and service set to null and children set to a new, empty list.

isBufferable
```
public boolean isBufferable()
```
Checks if the layer is bufferable.

Returns:

true if service type of this layer is ArcIms or ArcGis or if the layer has a featuretype, false otherwise

accept
```
public boolean accept(Layer.Visitor visitor,
                      javax.persistence.EntityManager em)
```
Do a depth-first traversal while the visitor returns true. Uses the call stack to save layers yet to visit.

Parameters:

visitor - the Layer.Visitor

em - the entity manager to use

Returns:

true if visitor accepted all layers

getDisplayName
```
public String getDisplayName()
```

toJSONObject

public org.json.JSONObject toJSONObject()
                                 throws org.json.JSONException

Throws:: org.json.JSONException

getCachedChildren

public List<Layer> getCachedChildren(javax.persistence.EntityManager em)

getApplicationLayers

public List<ApplicationLayer> getApplicationLayers(javax.persistence.EntityManager em)

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

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

isVirtual
```
public boolean isVirtual()
```

setVirtual

public void setVirtual(boolean virtual)

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

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

getTitleAlias
```
public String getTitleAlias()
```

setTitleAlias

public void setTitleAlias(String titleAlias)

getService
```
public GeoService getService()
```

setService

public void setService(GeoService service)

getCrsList

public Set<CoordinateReferenceSystem> getCrsList()

setCrsList

public void setCrsList(Set<CoordinateReferenceSystem> crsList)

getFeatureType

public SimpleFeatureType getFeatureType()

setFeatureType

public void setFeatureType(SimpleFeatureType featureType)

isFilterable
```
public boolean isFilterable()
```

setFilterable

public void setFilterable(boolean filterable)

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

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

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

isQueryable
```
public boolean isQueryable()
```

setQueryable

public void setQueryable(boolean queryable)

getReaders
```
public Set<String> getReaders()
```

setReaders

public void setReaders(Set<String> readers)

getWriters
```
public Set<String> getWriters()
```

setWriters

public void setWriters(Set<String> writers)

getPreventGeomEditors

public Set<String> getPreventGeomEditors()

setPreventGeomEditors

public void setPreventGeomEditors(Set<String> preventGeomEditors)

getChildren
```
public List<Layer> getChildren()
```

setChildren

public void setChildren(List<Layer> children)

getKeywords
```
public Set<String> getKeywords()
```

setKeywords

public void setKeywords(Set<String> keywords)

getDetails

public Map<String,ClobElement> getDetails()

setDetails

public void setDetails(Map<String,ClobElement> details)

getMaxScale
```
public Double getMaxScale()
```

setMaxScale

public void setMaxScale(Double maxScale)

getMinScale
```
public Double getMinScale()
```

setMinScale

public void setMinScale(Double minScale)

getTileset
```
public TileSet getTileset()
```

setTileset

public void setTileset(TileSet tileset)

getLegendImageUrl
```
public String getLegendImageUrl()
```

setLegendImageUrl

public void setLegendImageUrl(String legendImageUrl)

getBoundingBoxes

public Map<CoordinateReferenceSystem,BoundingBox> getBoundingBoxes()

setBoundingBoxes

public void setBoundingBoxes(Map<CoordinateReferenceSystem,BoundingBox> boundingBoxes)

getMatrixSets

public List<TileMatrixSet> getMatrixSets()

setMatrixSets

public void setMatrixSets(List<TileMatrixSet> matrixSets)

Class Layer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTRA_KEY_METADATA_URL

EXTRA_KEY_METADATA_STYLESHEET_URL

EXTRA_KEY_DOWNLOAD_URL

EXTRA_KEY_FILTERABLE

EXTRA_IMAGE_EXTENSION

EXTRA_KEY_ATTRIBUTION

DETAIL_WMS_STYLES

DETAIL_ALL_CHILDREN

DETAIL_ALTERNATE_LEGEND_IMAGE_URL

writers

preventGeomEditors

Constructor Detail

Layer

Layer

Method Detail

update

update

copyUserModifiedProperties

pluckCopy

isBufferable

accept

getDisplayName

toJSONObject

getCachedChildren

getApplicationLayers

getParent

setParent

isVirtual

setVirtual

getTitle

setTitle

getTitleAlias

setTitleAlias

getService

setService

getCrsList

setCrsList

getFeatureType

setFeatureType

isFilterable

setFilterable

getId

setId

getName

setName

isQueryable

setQueryable

getReaders

setReaders

getWriters

setWriters

getPreventGeomEditors

setPreventGeomEditors

getChildren

setChildren

getKeywords

setKeywords

getDetails

setDetails

getMaxScale

setMaxScale

getMinScale

setMinScale

getTileset

setTileset

getLegendImageUrl

setLegendImageUrl

getBoundingBoxes

setBoundingBoxes

getMatrixSets

setMatrixSets