org.geotools.styling
Class FeatureTypeStyleImpl

Object
  extended by FeatureTypeStyleImpl
All Implemented Interfaces:
Cloneable, FeatureTypeStyle

public class FeatureTypeStyleImpl
extends Object
implements FeatureTypeStyle, Cloneable

DOCUMENT ME!

Author:
James Macgill
Module:

Constructor Summary
protected FeatureTypeStyleImpl()
          Creates a new instance of FeatureTypeStyleImpl
protected FeatureTypeStyleImpl(List<Rule> rules)
           
protected FeatureTypeStyleImpl(Rule[] rules)
          Creates a new instance of FeatureTypeStyleImpl
 
Method Summary
 void accept(StyleVisitor visitor)
           
 void addRule(Rule rule)
           
 Object clone()
          Creates a deep copy clone of the FeatureTypeStyle.
 boolean equals(Object oth)
          Compares this FeatureTypeStyleImpl with another.
 String getAbstract()
          Getter for property abstractStr.
 Description getDescription()
          Description for this style.
 String getFeatureTypeName()
          Only features with the type name returned by this method should be styled by this feature type styler.
 String getName()
          Getter for property name.
 Rule[] getRules()
          Rules govern the appearance of any given feature to be styled by this styler.
 String[] getSemanticTypeIdentifiers()
          The SemanticTypeIdentifiers is experimental and is intended to be used to identify, using a community-controlled name(s), what the style is suitable to be used for.
 String getTitle()
          Getter for property title.
 int hashCode()
          Overrides hashCode.
 List<Rule> rules()
          Rules govern the appearance of any given feature to be styled by this styler.
 void setAbstract(String abstractStr)
          Setter for property abstractStr.
 void setFeatureTypeName(String name)
          Sets the type name of the features that this styler should be applied to.
 void setName(String name)
          Setter for property name.
 void setRules(Rule[] rules)
          Rules govern the appearance of any given feature to be styled by this styler.
 void setSemanticTypeIdentifiers(String[] types)
          The SemanticTypeIdentifiers is experimental and is intended to be used to identify, using a community-controlled name(s), what the style is suitable to be used for.
 void setTitle(String title)
          Setter for property title.
 String toString()
           
 
Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FeatureTypeStyleImpl

protected FeatureTypeStyleImpl(Rule[] rules)
Creates a new instance of FeatureTypeStyleImpl

Parameters:
rules - DOCUMENT ME!

FeatureTypeStyleImpl

protected FeatureTypeStyleImpl(List<Rule> rules)

FeatureTypeStyleImpl

protected FeatureTypeStyleImpl()
Creates a new instance of FeatureTypeStyleImpl

Method Detail

getFeatureTypeName

public String getFeatureTypeName()
Description copied from interface: FeatureTypeStyle
Only features with the type name returned by this method should be styled by this feature type styler.

Specified by:
getFeatureTypeName in interface FeatureTypeStyle
Returns:
The name of types that this styler applies to

getRules

public Rule[] getRules()
Description copied from interface: FeatureTypeStyle
Rules govern the appearance of any given feature to be styled by this styler. Each rule contains conditions based on scale and feature attribute values. In addition, rules contain the symbolizers which should be applied when the rule holds true.

Specified by:
getRules in interface FeatureTypeStyle
Returns:
The full set of rules contained in this styler.

rules

public List<Rule> rules()
Description copied from interface: FeatureTypeStyle
Rules govern the appearance of any given feature to be styled by this styler.

This is *the* list being used to manage the rules!

Specified by:
rules in interface FeatureTypeStyle

getSemanticTypeIdentifiers

public String[] getSemanticTypeIdentifiers()
Description copied from interface: FeatureTypeStyle
The SemanticTypeIdentifiers is experimental and is intended to be used to identify, using a community-controlled name(s), what the style is suitable to be used for. For example, a single style may be suitable to use with many different feature types. The syntax of the SemanticTypeIdentifiers string is undefined, but the strings "generic:line_string", "generic:polygon", "generic:point", "generic:text", "generic:raster", and "generic:any" are reserved to indicate that a FeatureTypeStyle may be used with any feature type with the corresponding default geometry type (i.e., no feature properties are referenced in the feature type style).

This method will be replaced by a live set semanticIdentifiers() in 2.6.x

Specified by:
getSemanticTypeIdentifiers in interface FeatureTypeStyle
Returns:
An array of strings representing systematic types which could be styled by this instance.

setSemanticTypeIdentifiers

public void setSemanticTypeIdentifiers(String[] types)
Description copied from interface: FeatureTypeStyle
The SemanticTypeIdentifiers is experimental and is intended to be used to identify, using a community-controlled name(s), what the style is suitable to be used for. For example, a single style may be suitable to use with many different feature types. The syntax of the SemanticTypeIdentifiers string is undefined, but the strings "generic:line_string", "generic:polygon", "generic:point", "generic:text", "generic:raster", and "generic:any" are reserved to indicate that a FeatureTypeStyle may be used with any feature type with the corresponding default geometry type (i.e., no feature properties are referenced in the feature type style).

Specified by:
setSemanticTypeIdentifiers in interface FeatureTypeStyle
Parameters:
types - An array of strings representing systematic types which could be styled by this instance.

setRules

public void setRules(Rule[] rules)
Description copied from interface: FeatureTypeStyle
Rules govern the appearance of any given feature to be styled by this styler. Each rule contains conditions based on scale and feature attribute values. In addition, rules contain the symbolizers which should be applied when the rule holds true.

Specified by:
setRules in interface FeatureTypeStyle
Parameters:
rules - The set of rules to be set for this styler.

addRule

public void addRule(Rule rule)
Specified by:
addRule in interface FeatureTypeStyle

setFeatureTypeName

public void setFeatureTypeName(String name)
Description copied from interface: FeatureTypeStyle
Sets the type name of the features that this styler should be applied to.

Specified by:
setFeatureTypeName in interface FeatureTypeStyle
Parameters:
name - The TypeName of the features to be styled by this instance.

getDescription

public Description getDescription()
Description copied from interface: FeatureTypeStyle
Description for this style.

Specified by:
getDescription in interface FeatureTypeStyle
Returns:
Human readable description for use in user interfaces

getAbstract

public String getAbstract()
Getter for property abstractStr.

Specified by:
getAbstract in interface FeatureTypeStyle
Returns:
Value of property abstractStr.

setAbstract

public void setAbstract(String abstractStr)
Setter for property abstractStr.

Specified by:
setAbstract in interface FeatureTypeStyle
Parameters:
abstractStr - New value of property abstractStr.

getName

public String getName()
Getter for property name.

Specified by:
getName in interface FeatureTypeStyle
Returns:
Value of property name.

setName

public void setName(String name)
Setter for property name.

Specified by:
setName in interface FeatureTypeStyle
Parameters:
name - New value of property name.

getTitle

public String getTitle()
Getter for property title.

Specified by:
getTitle in interface FeatureTypeStyle
Returns:
Value of property title.

setTitle

public void setTitle(String title)
Setter for property title.

Specified by:
setTitle in interface FeatureTypeStyle
Parameters:
title - New value of property title.

accept

public void accept(StyleVisitor visitor)
Specified by:
accept in interface FeatureTypeStyle

clone

public Object clone()
Creates a deep copy clone of the FeatureTypeStyle.

Overrides:
clone in class Object
See Also:
org.geotools.styling.FeatureTypeStyle#clone()

hashCode

public int hashCode()
Overrides hashCode.

Overrides:
hashCode in class Object
Returns:
The hashcode.

equals

public boolean equals(Object oth)
Compares this FeatureTypeStyleImpl with another.

Two FeatureTypeStyles are equal if they contain equal properties and an equal list of Rules.

Overrides:
equals in class Object
Parameters:
oth - The other FeatureTypeStyleImpl to compare with.
Returns:
True if this and oth are equal.

toString

public String toString()
Overrides:
toString in class Object


Copyright © 1996-2009 Geotools. All Rights Reserved.