Uses of Interface
org.orbisgis.legend.LegendStructure

Packages that use LegendStructure

Package	Description
org.orbisgis.legend	This package contains two interfaces that will be used to: Analyze the structure of a SE file; Present the thematic analysis found in it in a processable way
org.orbisgis.legend.structure.categorize
org.orbisgis.legend.structure.fill
org.orbisgis.legend.structure.fill.constant
org.orbisgis.legend.structure.graphic
org.orbisgis.legend.structure.interpolation
org.orbisgis.legend.structure.literal
org.orbisgis.legend.structure.parameter
org.orbisgis.legend.structure.recode
org.orbisgis.legend.structure.stroke
org.orbisgis.legend.structure.stroke.constant
org.orbisgis.legend.structure.viewbox
org.orbisgis.legend.thematic
org.orbisgis.legend.thematic.categorize
org.orbisgis.legend.thematic.constant
org.orbisgis.legend.thematic.map
org.orbisgis.legend.thematic.proportional
org.orbisgis.legend.thematic.recode

Uses of LegendStructure in org.orbisgis.legend

Subinterfaces of LegendStructure in org.orbisgis.legend

Modifier and Type	Interface and Description
interface	Legend Legend realizations represent patterns that can be found in a SE style, and that match well-known configuration as described in the geographic and cartographic literatures.

Methods in org.orbisgis.legend that return LegendStructure

Modifier and Type	Method and Description
LegendStructure	AbstractAnalyzer.getLegend()
LegendStructure	Analyzer.getLegend() Get all the elements that are, or are part of, a thematic analysis in this legend.

Methods in org.orbisgis.legend with parameters of type LegendStructure

Modifier and Type	Method and Description
void	AbstractAnalyzer.setLegend(LegendStructure leg) Set the LegendStructure associated to this Analyzer.

Uses of LegendStructure in org.orbisgis.legend.structure.categorize

Classes in org.orbisgis.legend.structure.categorize that implement LegendStructure

Modifier and Type	Class and Description
class	CategorizedColor
class	CategorizedLegend<U>
class	CategorizedReal This class embeds a RealParameter that can be either a literal or a categorize.
class	CategorizedString This class embeds a StringParameter that can be either a literal or a categorize.

Uses of LegendStructure in org.orbisgis.legend.structure.fill

Subinterfaces of LegendStructure in org.orbisgis.legend.structure.fill

Modifier and Type	Interface and Description
interface	FillLegend LegendStructure dedicated for Fill analysis.

Classes in org.orbisgis.legend.structure.fill that implement LegendStructure

Modifier and Type	Class and Description
class	RecodedSolidFillLegend A Legend that represents a SolidFill where the color is defined according to a Recode operation.
class	SolidFillLegend Generic LegendStructure representation of a SolidFill.

Methods in org.orbisgis.legend.structure.fill that return LegendStructure

Modifier and Type	Method and Description
LegendStructure	SolidFillLegend.getFillColorLegend() Retrieve the LegendStructure that is associated to the color of the inner Fill
LegendStructure	SolidFillLegend.getFillOpacityLegend() Gets the opacity associated to the inner SolidFill.

Constructors in org.orbisgis.legend.structure.fill with parameters of type LegendStructure

Constructor and Description
SolidFillLegend(SolidFill fill, LegendStructure colorLegend, LegendStructure rll) Build a SolidFillLegend using the Fill and LegendStructure instances given in parameter.

Uses of LegendStructure in org.orbisgis.legend.structure.fill.constant

Subinterfaces of LegendStructure in org.orbisgis.legend.structure.fill.constant

Modifier and Type	Interface and Description
interface	ConstantFillLegend
interface	ConstantSolidFill Common representation for all the kind of constant solid fills.

Classes in org.orbisgis.legend.structure.fill.constant that implement LegendStructure

Modifier and Type	Class and Description
class	ConstantSolidFillLegend A Legend that represents a SolidFill where the color is a Literal instance.
class	NullSolidFillLegend SolidFill fields that are set to null can be considered as constant in some situation.

Uses of LegendStructure in org.orbisgis.legend.structure.graphic

Classes in org.orbisgis.legend.structure.graphic that implement LegendStructure

Modifier and Type	Class and Description
class	ConstantFormWKN This abstract class is a common LegendStructure description for all the MarkGraphic instances where the only varying parameters are the dimensions of the associated ViewBox.
class	ConstantWKNLegend A Markgraphic, defined with a well-known name, whose all parameters are constant, whatever the input data.
class	MarkGraphicLegend The default LegendStructure for a MarkGraphic instance.
class	ProportionalWKNLegend This class is used to describe instances of MarkGraphic that embeds a simple proportional symbol configuration, associated to a WKN graphic.

Methods in org.orbisgis.legend.structure.graphic that return LegendStructure

Modifier and Type	Method and Description
LegendStructure	MarkGraphicLegend.getFillLegend() Get the LegendStructure associated to the Fill of the associated MarkGraphic.
LegendStructure	MarkGraphicLegend.getStrokeLegend() Get the LegendStructure associated to the Stroke contained in the inner MarkGraphic instance.
LegendStructure	MarkGraphicLegend.getViewBoxLegend() Get the LegendStructure associated to the ViewBox contained in the inner MarkGraphic instance.
LegendStructure	MarkGraphicLegend.getWknLegend() Get the legend associated to the inner well-known name representation.

Constructors in org.orbisgis.legend.structure.graphic with parameters of type LegendStructure

Constructor and Description
ConstantFormWKN(MarkGraphic mark, LegendStructure viewBoxLegend) Builds a new ConstantFormWKN from the given mark and viewBoxLegend.
ConstantFormWKN(MarkGraphic mark, StringLiteralLegend wknLegend, LegendStructure viewBoxLegend, ConstantSolidFill fillLegend, ConstantPenStroke strokeLegend) Build a default LegendStructure that describes a MarkGraphic instance.
MarkGraphicLegend(MarkGraphic mark, ParameterLegend wknLegend, LegendStructure viewBoxLegend, FillLegend fillLegend, StrokeLegend strokeLegend) Build a default LegendStructure that describes a MarkGraphic instance.

Uses of LegendStructure in org.orbisgis.legend.structure.interpolation

Classes in org.orbisgis.legend.structure.interpolation that implement LegendStructure

Modifier and Type	Class and Description
class	InterpolationLegend The default representation of an interpolation, in the legend.
class	LinearInterpolationLegend Analysis associated to a linear interpolation.
class	SqrtInterpolationLegend Analysis associated to an interpolation made on the square root of a numeric value.

Uses of LegendStructure in org.orbisgis.legend.structure.literal

Classes in org.orbisgis.legend.structure.literal that implement LegendStructure

Modifier and Type	Class and Description
class	ColorLiteralLegend LegendStructure associated to a numeric constant, that is represented as a ColorLiteral in the SE model.
class	RealLiteralLegend Legend associated to a numeric constant, that is represented as a RealLiteral in the SE model.
class	StringLiteralLegend LegendStructure that can be associated to a simple string literal.

Uses of LegendStructure in org.orbisgis.legend.structure.parameter

Subinterfaces of LegendStructure in org.orbisgis.legend.structure.parameter

Modifier and Type	Interface and Description
interface	NumericLegend LegendStructure instances that are associated to numeric values have to realizes this interface rather than LegendStructure.
interface	ParameterLegend

Uses of LegendStructure in org.orbisgis.legend.structure.recode

Subinterfaces of LegendStructure in org.orbisgis.legend.structure.recode

Modifier and Type	Interface and Description
interface	RecodedLegendStructure Gathers some method that must be provided by classes that are part of a unique value analysis.

Uses of LegendStructure in org.orbisgis.legend.structure.stroke

Subinterfaces of LegendStructure in org.orbisgis.legend.structure.stroke

Modifier and Type	Interface and Description
interface	StrokeLegend Legend analysis associated to a Stroke instance.

Classes in org.orbisgis.legend.structure.stroke that implement LegendStructure

Modifier and Type	Class and Description
class	CategorizedDashesPSLegend This class is associated to instances of PenStroke where an interval classification is made on the dash array.
class	ConstantColorAndDashesPSLegend Represents a PenStroke where the Color and the dash pattern are constant.
class	PenStrokeLegend A LegendStructure that gathers all the analysis that can be made inside a PenStroke.
class	ProportionalStrokeLegend PenStroke is defined using a Width attribute, which is a RealAttribute.
class	RecodedDashesPSLegend This class is associated to instances of PenStroke where a value classification is made on the dash array.
class	RecodedPenStroke Represents PenStroke instances that just contain Recode instances.

Methods in org.orbisgis.legend.structure.stroke that return LegendStructure

Modifier and Type	Method and Description
LegendStructure	PenStrokeLegend.getDashLegend() Get the analysis made on the dash array.
LegendStructure	PenStrokeLegend.getFillAnalysis() Get the analysis made on the Fill used to draw the associated PenStroke.

Methods in org.orbisgis.legend.structure.stroke with parameters of type LegendStructure

Modifier and Type	Method and Description
protected void	PenStrokeLegend.setDashLegend(LegendStructure ls) Replace the analysis that has been made on the dash array.

Constructors in org.orbisgis.legend.structure.stroke with parameters of type LegendStructure

Constructor and Description
CategorizedDashesPSLegend(PenStroke ps, NumericLegend width, LegendStructure fill, LegendStructure dash) Build a new instance of LegendStructure that matches a configuration where a categorization is made only on the dash array, and the other elements are constant or null.
ConstantColorAndDashesPSLegend(PenStroke ps, NumericLegend width, LegendStructure fill, LegendStructure dash) Build an instance of ConstantColorAndDashesPSLegend using the given parameters.
PenStrokeLegend(PenStroke ps, NumericLegend width, LegendStructure fill, LegendStructure dash) Build a new, default, PenStrokeLegend instance.
ProportionalStrokeLegend(PenStroke penStroke, LinearInterpolationLegend width, ConstantFillLegend fill, LegendStructure dashes) Build a new ProportionalStrokeLegend, using the given PenStroke.
RecodedDashesPSLegend(PenStroke ps, NumericLegend width, LegendStructure fill, LegendStructure dash) Build a new instance of LegendStructure that matches a configuration where a recode is made only on the dash array, and the other elements are constant or null.

Uses of LegendStructure in org.orbisgis.legend.structure.stroke.constant

Subinterfaces of LegendStructure in org.orbisgis.legend.structure.stroke.constant

Modifier and Type	Interface and Description
interface	ConstantPenStroke Interface to be implemented by legends that are associated to constant PenStroke.

Classes in org.orbisgis.legend.structure.stroke.constant that implement LegendStructure

Modifier and Type	Class and Description
class	ConstantPenStrokeLegend This class is used to represent instances of PenStroke whose parameters (width, fill and dash array) are all constant.
class	NullPenStrokeLegend A PenStroke that is null can be considered as a constant : it is not dependant upon any parameter and will always be (not) rendered the same way.

Uses of LegendStructure in org.orbisgis.legend.structure.viewbox

Subinterfaces of LegendStructure in org.orbisgis.legend.structure.viewbox

Modifier and Type	Interface and Description
interface	ViewBoxLegend

Classes in org.orbisgis.legend.structure.viewbox that implement LegendStructure

Modifier and Type	Class and Description
class	BivariateProportionalViewBox When using a ViewBox where both dimensions are associated with an interpolation which is both linear and made on the raw values, we are working with a bivariate proportional symbol.
class	ConstantViewBox Represents a ViewBox that does not change, whatever the processed data is.
class	DefaultViewBox ViewBox instances can all be described as being associated to two random NumericLegend instances.
class	MonovariateLinearVB A symbol can be said proportional is one of is dimensions variates linearly upon a numeric field.
class	MonovariateProportionalViewBox The representation of a monovariate proportional symbol, that has been defined using a ViewBox.

Uses of LegendStructure in org.orbisgis.legend.thematic

Classes in org.orbisgis.legend.thematic that implement LegendStructure

Modifier and Type	Class and Description
class	ConstantColorAndDashesLine Abstract a representation of line whose Color and dash array are constant, but where the management of the width is unknown.
class	ConstantFormPoint This class gathers methods that are common to thematic analysis where the Stroke, Fill and well-known name are constant.
class	ConstantStrokeArea Represents an AreaSymbolizer of which the Stroke is a constant PenStroke instance, that can be recognized as a ConstantPenStrokeLegend.
class	SymbolizerLegend Gathers method that are common to all the Legend realizations.

Methods in org.orbisgis.legend.thematic that return LegendStructure

Modifier and Type	Method and Description
abstract LegendStructure	ConstantColorAndDashesLine.getStrokeLegend() Get the LegendStructure associated to the Stroke of this ConstantColorAndDashesLine.

Uses of LegendStructure in org.orbisgis.legend.thematic.categorize

Classes in org.orbisgis.legend.thematic.categorize that implement LegendStructure

Modifier and Type	Class and Description
class	AbstractCategorizedLegend<U extends SymbolParameters>
class	CategorizedArea This class intends to propose an API that is useful to handle AreaSymbolizer instances that are made of literal or categorized parameters.
class	CategorizedLine This class intends to propose an API that is useful to handle LineSymbolizer instances that are made of literal or categorized parameters.
class	CategorizedPoint This class intends to propose an API that is useful to handle PointSymbolizer instances that are made of literal or categorized parameters.

Uses of LegendStructure in org.orbisgis.legend.thematic.constant

Subinterfaces of LegendStructure in org.orbisgis.legend.thematic.constant

Modifier and Type	Interface and Description
interface	IUniqueSymbolArea Represents the symbols that contains parameters associated to the management of a solid fill.
interface	IUniqueSymbolLine Represents the symbols that contains parameters associated to the management of a PenStroke.
interface	UniqueSymbol Common interface to all the Legend instances that represent a unique symbol.

Classes in org.orbisgis.legend.thematic.constant that implement LegendStructure

Modifier and Type	Class and Description
class	UniqueSymbolArea Represents a AreaSymbolizer whose parameters are constant, whatever the input data are.
class	UniqueSymbolLine Represents a LineSymbolizer whose parameters are constant, whatever the input data are.
class	UniqueSymbolPoint We are dealing with a simple point symbolizer.

Methods in org.orbisgis.legend.thematic.constant that return LegendStructure

Modifier and Type	Method and Description
LegendStructure	UniqueSymbolLine.getStrokeLegend() Gets the LegendStructure associated to this UniqueSymbolLine.

Uses of LegendStructure in org.orbisgis.legend.thematic.map

Classes in org.orbisgis.legend.thematic.map that implement LegendStructure

Modifier and Type	Class and Description
class	MappedLegend<T,U extends SymbolParameters> This abstract class gathers methods that will be common to instances of unique value classifications and interval classifications.

Uses of LegendStructure in org.orbisgis.legend.thematic.proportional

Classes in org.orbisgis.legend.thematic.proportional that implement LegendStructure

Modifier and Type	Class and Description
class	ProportionalLine A ProportionalLine represents a LineSymbolizer containing a PenStroke whose only varying parameter is the width of the line.
class	ProportionalPoint A ProportionalPoint is a ConstantFormPoint whose ViewBox is defined so that it can be recognized as a MonovariateProportionalViewBox.

Uses of LegendStructure in org.orbisgis.legend.thematic.recode

Classes in org.orbisgis.legend.thematic.recode that implement LegendStructure

Modifier and Type	Class and Description
class	AbstractRecodedLegend<U extends SymbolParameters> Common base for all the legends describing unique value analysis.
class	RecodedArea Wrapper for unique value classification that are made on AreaSymbolizer instances.
class	RecodedLine Wrapper for lines made of a PenStroke where parameters are made of Recode instances on a common field or of Literal.
class	RecodedPoint Wrapper for unique value classification that are made on PointSymbolizer instances.