/* (c) 2014 Open Source Geospatial Foundation - all rights reserved
* (c) 2001 - 2013 OpenPlans
* This code is licensed under the GPL 2.0 license, available at the root
* application directory.
*/
package org.geoserver.catalog.impl;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.geoserver.catalog.AttributionInfo;
import org.geoserver.catalog.AuthorityURLInfo;
import org.geoserver.catalog.CatalogVisitor;
import org.geoserver.catalog.LayerIdentifierInfo;
import org.geoserver.catalog.LayerInfo;
import org.geoserver.catalog.LegendInfo;
import org.geoserver.catalog.MetadataMap;
import org.geoserver.catalog.ResourceInfo;
import org.geoserver.catalog.StyleInfo;
import org.geotools.util.logging.Logging;
public class LayerInfoImpl implements LayerInfo {
static final Logger LOGGER = Logging.getLogger(LayerInfoImpl.class);
static final String KEY_ADVERTISED = "advertised";
protected String id;
// this property has been left to ensure backwards compatibility with xstream but it's marked transient
// to avoid its value being serialized.
// TODO: revert to normal property when the resource/publishing split is done
transient protected String name;
private String title;
private String abstractTxt;
protected String path;
protected LayerInfo.Type type;
protected StyleInfo defaultStyle;
protected Set<StyleInfo> styles = new HashSet<StyleInfo>();
protected ResourceInfo resource;
protected LegendInfo legend;
// this property has been left to ensure backwards compatibility with xstream but it's marked transient
// to avoid its value being serialized.
// TODO: revert to normal property when the resource/publishing split is done
transient protected boolean enabled;
// this property has been left to ensure backwards compatibility with xstream but it's marked transient
// to avoid its value being serialized.
// TODO: revert to normal property when the resource/publishing split is done
transient protected Boolean advertised;
protected Boolean queryable;
protected Boolean opaque;
protected MetadataMap metadata = new MetadataMap();
protected AttributionInfo attribution;
/**
* This property is transient in 2.1.x series and stored under the metadata map with key
* "authorityURLs", and a not transient in the 2.2.x series.
*
* @since 2.1.3
*/
protected List<AuthorityURLInfo> authorityURLs = new ArrayList<AuthorityURLInfo>(1);
/**
* This property is transient in 2.1.x series and stored under the metadata map with key
* "identifiers", and a not transient in the 2.2.x series.
*
* @since 2.1.3
*/
protected List<LayerIdentifierInfo> identifiers = new ArrayList<LayerIdentifierInfo>(1);
@Override
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
@Override
public String getName() {
if (resource == null) {
throw new NullPointerException("Unable to get Layer name without an underlying resource");
}
return resource.getName();
// TODO: uncomment back when resource/publish split is complete
// return name;
}
@Override
public void setName(String name) {
// TODO: remove this log and reinstate field assignment when resource/publish split is complete
LOGGER.log(Level.FINE, "Warning, some code is setting the LayerInfo name, but that will be ignored");
this.name = name;
if (resource == null) {
throw new NullPointerException("Layer name must not be set without an underlying resource");
}
resource.setName(name);
}
@Override
public String prefixedName() {
return this.getResource().getStore().getWorkspace().getName() + ":" + getName();
}
@Override
public Type getType() {
return type;
}
@Override
public void setType(Type type) {
this.type = type;
}
@Override
public String getPath() {
return path;
}
@Override
public void setPath(String path) {
this.path = path;
}
@Override
public StyleInfo getDefaultStyle() {
return defaultStyle;
}
@Override
public void setDefaultStyle(StyleInfo defaultStyle) {
this.defaultStyle = defaultStyle;
}
public Set<StyleInfo> getStyles() {
return styles;
}
public void setStyles(Set<StyleInfo> styles) {
this.styles = styles;
}
@Override
public ResourceInfo getResource() {
return resource;
}
@Override
public void setResource(ResourceInfo resource) {
this.resource = resource;
}
@Override
public LegendInfo getLegend() {
return legend;
}
@Override
public void setLegend(LegendInfo legend) {
this.legend = legend;
}
@Override
public AttributionInfo getAttribution() {
return attribution;
}
@Override
public void setAttribution(AttributionInfo attribution) {
this.attribution = attribution;
}
@Override
public boolean isEnabled() {
if (resource == null) {
throw new NullPointerException("Unable to get Layer enabled flag without an underlying resource");
}
return resource.isEnabled();
// TODO: uncomment back when resource/publish split is complete
// return name;
}
/**
* @see LayerInfo#enabled()
*/
@Override
public boolean enabled() {
ResourceInfo resource = getResource();
boolean resourceEnabled = resource != null && resource.enabled();
boolean thisEnabled = this.isEnabled();
return resourceEnabled && thisEnabled;
}
@Override
public void setEnabled(boolean enabled) {
// TODO: remove this log and reinstate field assignment when resource/publish split is complete
LOGGER.log(Level.FINE, "Warning, some code is setting the LayerInfo enabled flag, but that will be ignored");
this.enabled = enabled;
if (resource == null) {
throw new NullPointerException("Layer enabled flag must not be set without an underlying resource");
}
resource.setEnabled(enabled);
}
@Override
public MetadataMap getMetadata() {
return metadata;
}
public void setMetadata(MetadataMap metadata) {
this.metadata = metadata;
}
@Override
public void accept(CatalogVisitor visitor) {
visitor.visit(this);
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result
+ ((defaultStyle == null) ? 0 : defaultStyle.hashCode());
result = prime * result + ((id == null) ? 0 : id.hashCode());
result = prime * result + ((legend == null) ? 0 : legend.hashCode());
// TODO: add back when resource publish split is in place
// result = prime * result + ((name == null) ? 0 : name.hashCode());
result = prime * result + ((path == null) ? 0 : path.hashCode());
result = prime * result
+ ((resource == null) ? 0 : resource.hashCode());
result = prime * result + ((styles == null) ? 0 : styles.hashCode());
result = prime * result + ((type == null) ? 0 : type.hashCode());
result = prime * result + ((attribution == null) ? 0 : attribution.hashCode());
result = prime * result + ((authorityURLs == null) ? 0 : authorityURLs.hashCode());
result = prime * result + ((identifiers == null) ? 0 : identifiers.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (!(obj instanceof LayerInfo))
return false;
final LayerInfo other = (LayerInfo) obj;
if (defaultStyle == null) {
if (other.getDefaultStyle() != null)
return false;
} else if (!defaultStyle.equals(other.getDefaultStyle()))
return false;
if (id == null) {
if (other.getId() != null)
return false;
} else if (!id.equals(other.getId()))
return false;
if (legend == null) {
if (other.getLegend() != null)
return false;
} else if (!legend.equals(other.getLegend()))
return false;
// TODO: add back when resource/publish split is in place
// if (name == null) {
// if (other.getName() != null)
// return false;
// } else if (!name.equals(other.getName()))
// return false;
if (path == null) {
if (other.getPath() != null)
return false;
} else if (!path.equals(other.getPath()))
return false;
if (resource == null) {
if (other.getResource() != null)
return false;
} else if (!resource.equals(other.getResource()))
return false;
if (styles == null) {
if (other.getStyles() != null)
return false;
} else if (!styles.equals(other.getStyles()))
return false;
if (type == null) {
if (other.getType() != null)
return false;
} else if (!type.equals(other.getType()))
return false;
if (attribution == null) {
if (other.getAttribution() != null)
return false;
} else if (!attribution.equals(other.getAttribution()))
return false;
if(authorityURLs == null){
if (other.getAuthorityURLs() != null)
return false;
} else if (!authorityURLs.equals(other.getAuthorityURLs()))
return false;
if(identifiers == null){
if (other.getIdentifiers() != null)
return false;
} else if (!identifiers.equals(other.getIdentifiers()))
return false;
return true;
}
@Override
public String toString() {
return new StringBuilder(getClass().getSimpleName()).append('[').append(getName()).append(
", resource:").append(resource).append(']').toString();
}
@Override
public void setQueryable(boolean queryable) {
this.queryable = queryable;
}
@Override
public boolean isQueryable() {
return this.queryable == null? true : this.queryable.booleanValue();
}
@Override
public void setOpaque(boolean opaque) {
this.opaque = opaque;
}
@Override
public boolean isOpaque() {
return this.opaque == null? false : this.opaque.booleanValue();
}
@Override
public boolean isAdvertised() {
if (resource == null) {
throw new NullPointerException("Unable to get Layer advertised flag without an underlying resource");
}
return resource.isAdvertised();
// TODO: uncomment back when resource/publish split is complete
// return name;
}
@Override
public void setAdvertised(boolean advertised) {
// TODO: remove this log and reinstate field assignment when resource/publish split is complete
LOGGER.log(Level.FINE, "Warning, some code is setting the LayerInfo advertised flag, but that will be ignored");
this.advertised = advertised;
if (resource == null) {
throw new NullPointerException("Layer advertised flag must not be set without an underlying resource");
}
resource.setAdvertised(advertised);
}
@Override
public List<AuthorityURLInfo> getAuthorityURLs() {
return authorityURLs;
}
public void setAuthorityURLs(List<AuthorityURLInfo> authorities){
this.authorityURLs = authorities;
}
@Override
public List<LayerIdentifierInfo> getIdentifiers() {
return identifiers;
}
public void setIdentifiers(List<LayerIdentifierInfo> identifiers){
this.identifiers = identifiers;
}
@Override
public String getTitle() {
return title;
}
@Override
public void setTitle(String title) {
this.title = title;
}
@Override
public String getAbstract() {
return abstractTxt;
}
@Override
public void setAbstract(String abstractTxt) {
this.abstractTxt = abstractTxt;
}
}