it.geosolutions.geoserver.rest.encoder.GSCachedLayerEncoder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geoserver-manager Show documentation
Show all versions of geoserver-manager Show documentation
GeoServer Manager is a library to interact with GeoServer
The scope of this library is to have a simple API, and use as few external
libs as possible.
The newest version!
/*
* GeoServer-Manager - Simple Manager Library for GeoServer
*
* Copyright (C) 2007,2011 GeoSolutions S.A.S.
* http://www.geo-solutions.it
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package it.geosolutions.geoserver.rest.encoder;
import it.geosolutions.geoserver.rest.decoder.utils.JDOMBuilder;
import it.geosolutions.geoserver.rest.encoder.utils.ElementUtils;
import it.geosolutions.geoserver.rest.encoder.utils.PropertyXMLEncoder;
import org.jdom.Element;
/**
* GSCachedLayerEncoder class.
*
* @author niels
* @version $Id: $
*/
public class GSCachedLayerEncoder extends PropertyXMLEncoder {
/** Constant MIME_FORMATS="mimeFormats" */
public final static String MIME_FORMATS = "mimeFormats";
/** Constant GRIDSUBSETS="gridSubsets" */
public final static String GRIDSUBSETS = "gridSubsets";
/** Constant PARAMETER_FILTERS="parameterFilters" */
public final static String PARAMETER_FILTERS = "parameterFilters";
final private Element mimeFormatsListEncoder;
final private Element gridSubsetsListEncoder;
final private Element parameterFiltersListEncoder;
private GSCachedLayerEncoder(Element root) {
super(root);
this.mimeFormatsListEncoder = root.getChild(MIME_FORMATS);
this.gridSubsetsListEncoder = root.getChild(GRIDSUBSETS);
this.parameterFiltersListEncoder = root.getChild(PARAMETER_FILTERS);
}
/**
* build
*
* @param response a {@link java.lang.String} object.
* @return a {@link it.geosolutions.geoserver.rest.encoder.GSCachedLayerEncoder} object.
*/
public static GSCachedLayerEncoder build(String response) {
Element pb = JDOMBuilder.buildElement(response);
if(pb != null) {
return new GSCachedLayerEncoder(pb);
} else {
return null;
}
}
/**
* Constructor for GSCachedLayerEncoder.
*/
public GSCachedLayerEncoder() {
this(true);
}
/**
* Constructor for GSCachedLayerEncoder.
*
* @param encodeLists a boolean.
*/
public GSCachedLayerEncoder(boolean encodeLists) {
super("GeoServerLayer");
setEnabled(true);
mimeFormatsListEncoder = new Element(MIME_FORMATS);
gridSubsetsListEncoder = new Element(GRIDSUBSETS);
parameterFiltersListEncoder = new Element(PARAMETER_FILTERS);
if (encodeLists) {
addContent(mimeFormatsListEncoder);
addContent(gridSubsetsListEncoder);
addContent(parameterFiltersListEncoder);
}
}
void encodeMimeFormats(boolean encoded) {
if (encoded) {
if (this.get(mimeFormatsListEncoder.getName()) == null) {
addContent(mimeFormatsListEncoder);
}
} else {
remove(mimeFormatsListEncoder.getName());
}
}
void encodeGridSubsets(boolean encoded) {
if (encoded) {
if (this.get(gridSubsetsListEncoder.getName()) == null) {
addContent(gridSubsetsListEncoder);
}
} else {
remove(gridSubsetsListEncoder.getName());
}
}
void encodeParameterFilters(boolean encoded) {
if (encoded) {
if (this.get(parameterFiltersListEncoder.getName()) == null) {
addContent(parameterFiltersListEncoder);
}
} else {
remove(parameterFiltersListEncoder.getName());
}
}
/**
* setId
*
* @param id a {@link java.lang.String} object.
*/
public void setId(String id) {
set("id", id);
}
/**
* getId
*
* @return a {@link java.lang.String} object.
*/
public String getId() {
final Element node = get("id");
return node != null ? node.getText() : null;
}
/**
* setEnabled
*
* @param enable true if layer should be set to enabled
*/
public void setEnabled(boolean enable) {
if (enable)
set("enabled", "true");
else
set("enabled", "false");
}
/**
* isEnabled
*
* @return a boolean.
*/
public boolean isEnabled() {
final Element node = get("enabled");
return node != null ? Boolean.parseBoolean(node.getText()) : null;
}
/**
* setInMemoryCached
*
* @param enable a boolean.
*/
public void setInMemoryCached(boolean enable) {
if (enable)
set("inMemoryCached", "true");
else
set("inMemoryCached", "false");
}
/**
* isInMemoryCached
*
* @return a boolean.
*/
public boolean isInMemoryCached() {
final Element node = get("inMemoryCached");
return node != null ? Boolean.parseBoolean(node.getText()) : null;
}
/**
* setBlobStoreId
*
* @param blobStoreId a {@link java.lang.String} object.
*/
public void setBlobStoreId(String blobStoreId) {
set("blobStoreId", blobStoreId);
}
/**
* getBlobStoreId
*
* @return a {@link java.lang.String} object.
*/
public String getBlobStoreId() {
final Element node = get("blobStoreId");
return node != null ? node.getText() : null;
}
/**
* setExpireCache
*
* @param expireCache a int.
*/
public void setExpireCache(int expireCache) {
set("expireCache", Integer.toString(expireCache));
}
/**
* getExpireCache
*
* @return a int.
*/
public int getExpireCache() {
final Element node = get("expireCache");
return node != null ? Integer.parseInt(node.getText()) : null;
}
/**
* setExpireClients
*
* @param expireClients a int.
*/
public void setExpireClients(int expireClients) {
set("expireClients", Integer.toString(expireClients));
}
/**
* getExpireClients
*
* @return a int.
*/
public int getExpireClients() {
final Element node = get("expireClients");
return node != null ? Integer.parseInt(node.getText()) : null;
}
/**
* setName
*
* @param name a {@link java.lang.String} object.
*/
public void setName(String name) {
set("name", name);
}
/**
* getName
*
* @return a {@link java.lang.String} object.
*/
public String getName() {
final Element node = get("name");
return node != null ? node.getText() : null;
}
/**
* setGutter
*
* @param gutter a int.
*/
public void setGutter(int gutter) {
set("gutter", Integer.toString(gutter));
}
/**
* getGutter
*
* @return a int.
*/
public int getGutter() {
final Element node = get("gutter");
return node != null ? Integer.parseInt(node.getText()) : null;
}
/**
* setMetaWidthHeight
*
* @param values a int.
*/
public void setMetaWidthHeight(int... values) {
final Element el = new Element("metaWidthHeight");
for (int value : values) {
final Element elChild = new Element("int");
elChild.setText(Integer.toString(value));
el.addContent(elChild);
}
Element pp;
if ((pp = ElementUtils.contains(getRoot(), "metaWidthHeight")) != null) {
ElementUtils.remove(pp, pp);
}
addContent(el);
}
/**
* Add a mime format
*
* @param mimeFormat a {@link java.lang.String} object.
*/
public void addMimeFormat(String mimeFormat) {
final Element el = new Element("string");
el.setText(mimeFormat);
mimeFormatsListEncoder.addContent(el);
}
/**
* Add a mime format
*
* @param type a {@link java.lang.String} object.
* @param key a {@link java.lang.String} object.
* @param defaultValue a {@link java.lang.String} object.
*/
public void addParameterFilter(String type, String key, String defaultValue) {
final Element el = new Element(type);
final Element elKey = new Element("key");
elKey.setText(key);
el.addContent(elKey);
final Element elDefaultValue = new Element("defaultValue");
elDefaultValue.setText(defaultValue);
el.addContent(elDefaultValue);
parameterFiltersListEncoder.addContent(el);
}
/**
* Add a grid subset
*
* @param gridSetName a {@link java.lang.String} object.
* @param zoomStart a {@link java.lang.Integer} object.
* @param zoomStop a {@link java.lang.Integer} object.
* @param minCachedLevel a {@link java.lang.Integer} object.
* @param maxCachedLevel a {@link java.lang.Integer} object.
*/
public void addGridSubset(String gridSetName, Integer zoomStart, Integer zoomStop,
Integer minCachedLevel, Integer maxCachedLevel) {
final Element el = new Element("gridSubset");
final Element elName = new Element("gridSetName");
elName.setText(gridSetName);
el.addContent(elName);
if (zoomStart != null) {
final Element elZoomStart = new Element("zoomStart");
elZoomStart.setText(zoomStart.toString());
el.addContent(elZoomStart);
}
if (zoomStop != null) {
final Element elZoomStop = new Element("zoomStop");
elZoomStop.setText(zoomStop.toString());
el.addContent(elZoomStop);
}
if (minCachedLevel != null) {
final Element elMin = new Element("minCachedLevel");
elMin.setText(minCachedLevel.toString());
el.addContent(elMin);
}
if (maxCachedLevel != null) {
final Element elMax = new Element("maxCachedLevel");
elMax.setText(maxCachedLevel.toString());
el.addContent(elMax);
}
gridSubsetsListEncoder.addContent(el);
}
public String getGridSubsetName(int index) {
return ((Element) gridSubsetsListEncoder.getChildren().get(index))
.getChildText("gridSetName").trim();
}
public Integer getGridSubsetZoomStart(int index) {
String s = ((Element) gridSubsetsListEncoder.getChildren().get(index))
.getChildText("zoomStart");
return s == null ? null : Integer.parseInt(s);
}
public Integer getGridSubsetZoomStop(int index) {
String s = ((Element) gridSubsetsListEncoder.getChildren().get(index))
.getChildText("zoomStop");
return s == null ? null : Integer.parseInt(s);
}
public Integer getGridSubsetMinCachedLevel(int index) {
String s = ((Element) gridSubsetsListEncoder.getChildren().get(index))
.getChildText("minCachedLevel");
return s == null ? null : Integer.parseInt(s);
}
public Integer getGridSubsetMaxCachedLevel(int index) {
String s = ((Element) gridSubsetsListEncoder.getChildren().get(index))
.getChildText("maxCachedLevel");
return s == null ? null : Integer.parseInt(s);
}
public String getMimeFormat(int index) {
return ((Element) mimeFormatsListEncoder.getChildren().get(index)).getValue().trim();
}
public String getParameterFilterKey(int index) {
return ((Element) parameterFiltersListEncoder.getChildren().get(index)).getChildText("key").trim();
}
public String getParameterFilterDefaultValue(int index) {
return ((Element) parameterFiltersListEncoder.getChildren().get(index))
.getChildText("defaultValue").trim();
}
public String getParameterFilterType(int index) {
return ((Element) parameterFiltersListEncoder.getChildren().get(index))
.getName();
}
}