/*$************************************************************************************************
**
** $Id: FeatureStyle.java 831 2006-05-01 00:27:23Z Desruisseaux $
**
** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/sld/FeatureStyle.java $
**
** Copyright (C) 2005 Open GIS Consortium, Inc.
** All Rights Reserved. http://www.opengis.org/legal/
**
*************************************************************************************************/
package org.opengis.sld;
// J2SE direct dependencies
import java.util.List;
// OpenGIS direct dependencies
import org.opengis.util.InternationalString;
// Annotations
import org.opengis.annotation.XmlElement;
/**
* Represents a style that applies to the features of a given type.
*
* @version Implementation specification 1.0
* @author Chris Dillard (SYS Technologies)
* @since GeoAPI 2.0
*/
@XmlElement("FeatureTypeStyle")
public interface FeatureStyle {
/**
* Returns a name for this style.
* This can be any string that uniquely identifies this style within a given
* canvas. It is not meant to be human-friendly. (The "title" property is
* meant to be human friendly.)
*/
@XmlElement("Name")
String getName();
/**
* Sets the name for this style.
* See {@link #getName} for details.
*/
@XmlElement("Name")
void setName(String name);
/**
* Returns the human readable title of this style.
* This can be any string, but should be fairly short as it is intended to
* be used in list boxes or drop down menus or other selection interfaces.
*/
@XmlElement("Title")
InternationalString getTitle();
/**
* Sets the human readable title of this style.
* See {@link #getTitle} for details.
*/
@XmlElement("Title")
void setTitle(InternationalString title);
/**
* Returns a human readable, prose description of this style.
* This can be any string and can consist of any amount of text.
*/
@XmlElement("Abstract")
InternationalString getAbstract();
/**
* Sets the human readable, prose description of this style.
* See {@link #getAbstract} for details.
*/
@XmlElement("Abstract")
void setAbstract(InternationalString abs);
/**
* Returns the name of the feature type that this style is meant to act
* upon. This may return null if a style can operate on many different
* feature types.
*/
@XmlElement("FeatureTypeName")
String getFeatureTypeName();
/**
* Sets the name of the feature type that this style is meant to act upon.
* See {@link #getFeatureTypeName} for details.
*/
@XmlElement("FeatureTypeName")
void setFeatureTypeName(String featureTypeName);
/**
* Returns a string that identifies the more general "type" of geometry
* that this style is meant to act upon.
* In the current OGC specifications, this is an experimental element and
* can take only one of the following values:
*
*
* - {@code generic:point}
* - {@code generic:line}
* - {@code generic:polygon}
* - {@code generic:text}
* - {@code generic:raster}
* - {@code generic:any}
*
*
* The returned list is the "live" list and can be modified, both by adding and
* removing rules. This is why there is no {@code setSemanticTypeIdentifiers} method.
*/
@XmlElement("SemanticTypeIdentifier")
List getSemanticTypeIdentifiers();
/**
* Returns the list of rules contained by this style. The returned list is
* the "live" list and can be modified, both by adding and removing rules.
* This is why there is no {@code setRules} method.
*/
@XmlElement("Rule")
List getRules();
}
Ads help maintain this website.