org.gvsig.annotation

Interface AnnotationManager

All Known Implementing Classes:

DefaultAnnotationManager

public interface AnnotationManager

This class is responsible of the management of the library's business logic. It is the library's main entry point, and provides all the services to manage AnnotationCreationServices.

See Also:

AnnotationCreationService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FONTCOLOR_ATTRIBUTE_NAME Name of the datastore attribute that contains the font color of the annotation.
static java.lang.String	FONTHEGTH_ATTRIBUTE_NAME Name of the datastore attribute that contains the font heigth of the annotation.
static java.lang.String	FONTROTATION_ATTRIBUTE_NAME Name of the datastore attribute that contains the font rotation of the annotation.
static java.lang.String	FONTSTYLE_ATTRIBUTE_NAME Name of the datastore attribute that contains the font style of the annotation.
static java.lang.String	FONTTYPE_ATTRIBUTE_NAME Name of the datastore attribute that contains the font type of the annotation.
static java.lang.String	TEXTVALUE_ATTRIBUTE_NAME Name of the datastore attribute that contains the text of the annotation.

Method Summary

Modifier and Type	Method and Description
void	addFontStyle(java.lang.String fontStyle) It adds a new value for the font style field.
void	addFontType(java.lang.String fontType) It adds a new value for the font type field.
AnnotationCreationService	getAnnotationCreationService(FeatureStore featureStore) Create an instance of a AnnotationCreationService.
AnnotationPositionCalculator	getAnnotationPositionCalculator(java.lang.String name) It returns an object that can be used to create the point where the annotation is displayed.
java.util.List<java.lang.String>	getAnnotationPositionCalculatorList()
AnnotationPositionCalculator	getDefaultAnnotationPositionCalculator() It returns the default AnnotationPositionCalculator.
int	getDefaultFontColor() Value used like the default value for the font color field.
double	getDefaultFontHeight() Value used like the default value for the font height field.
double	getDefaultFontRotation() Value used like the default value for the font rotation field.
java.lang.String	getDefaultFontStyle() Value used like the default value for the font style field.
java.lang.String	getDefaultFontType() Value used like the default value for the font type field.
java.lang.String	getDefaultTextValue() Value used like the default value for the text field.
java.util.List<java.lang.String>	getFontStyles()
java.util.List<java.lang.String>	getFontTypes()
void	registerAnnotationPositionCalculator(java.lang.String name, java.lang.Class annotationPositionCalculatorClass) It registers a class that can be used to caclulate the position of an annotation.
void	registerDefaultAnnotationPositionCalculator(java.lang.Class annotationPositionCalculatorClass) It registers the default implementation of an AnnotationPositionCalculator class.
void	setDefaultFontColor(java.awt.Color fontColor) Set the default value for the font color field.
void	setDefaultFontColor(int fontColor) Set the default value for the font color field.
void	setDefaultFontHeight(double fontHeight) Set the default value for the font height field.
void	setDefaultFontRotation(double fontRotation) Set the default value for the font rotation field.
void	setDefaultFontStyle(java.lang.String fontStyle) Set the default value for the font style field.
void	setDefaultFontType(java.lang.String fontType) Set the default value for the font type field.
void	setDefaultTextValue(java.lang.String textValue) Set the default value for the text field.

Field Detail

TEXTVALUE_ATTRIBUTE_NAME

static final java.lang.String TEXTVALUE_ATTRIBUTE_NAME

Name of the datastore attribute that contains the text of the annotation.

See Also:

Constant Field Values

FONTTYPE_ATTRIBUTE_NAME

static final java.lang.String FONTTYPE_ATTRIBUTE_NAME

Name of the datastore attribute that contains the font type of the annotation.

See Also:

Constant Field Values

FONTSTYLE_ATTRIBUTE_NAME

static final java.lang.String FONTSTYLE_ATTRIBUTE_NAME

Name of the datastore attribute that contains the font style of the annotation.

See Also:

Constant Field Values

FONTCOLOR_ATTRIBUTE_NAME

static final java.lang.String FONTCOLOR_ATTRIBUTE_NAME

Name of the datastore attribute that contains the font color of the annotation.

See Also:

Constant Field Values

FONTROTATION_ATTRIBUTE_NAME

static final java.lang.String FONTROTATION_ATTRIBUTE_NAME

Name of the datastore attribute that contains the font rotation of the annotation.

See Also:

Constant Field Values

FONTHEGTH_ATTRIBUTE_NAME

static final java.lang.String FONTHEGTH_ATTRIBUTE_NAME

Name of the datastore attribute that contains the font heigth of the annotation.

See Also:

Constant Field Values

Method Detail

getAnnotationCreationService

AnnotationCreationService getAnnotationCreationService(FeatureStore featureStore)
                                                throws ServiceException

Create an instance of a AnnotationCreationService.

Parameters:

the - feature store that is used like input.

Returns:

AnnotationCreationService

Throws:

ServiceException - if there is an error getting the service

registerAnnotationPositionCalculator

void registerAnnotationPositionCalculator(java.lang.String name,
                                          java.lang.Class annotationPositionCalculatorClass)

It registers a class that can be used to caclulate the position of an annotation.

Parameters:

name - The name used to register the class.

annotationPositionCalculatorClass - The class that is able to calculate an annotation point.

registerDefaultAnnotationPositionCalculator

void registerDefaultAnnotationPositionCalculator(java.lang.Class annotationPositionCalculatorClass)

It registers the default implementation of an AnnotationPositionCalculator class. It will be used by default if the user don't specify any of them.

Parameters:

annotationPositionCalculatorClass - A class that is able to calculate an annotation point.

getAnnotationPositionCalculator

AnnotationPositionCalculator getAnnotationPositionCalculator(java.lang.String name)
                                                      throws AnnotationPositionCalculatorCreationException

It returns an object that can be used to create the point where the annotation is displayed.

Parameters:

name - the name used to register the class.

Returns:

a class that is able to calculate an annotation point.

Throws:

AnnotationPositionCalculatorCreationException - if is not possible to create the object.

getDefaultAnnotationPositionCalculator

AnnotationPositionCalculator getDefaultAnnotationPositionCalculator()
                                                             throws AnnotationPositionCalculatorCreationException

It returns the default AnnotationPositionCalculator.

Returns:

the default AnnotationPositionCalculator.

Throws:

AnnotationPositionCalculatorCreationException - if is not possible to create the object.

getAnnotationPositionCalculatorList

java.util.List<java.lang.String> getAnnotationPositionCalculatorList()

Returns:

the list of the names used to register the AnnotationPositionCalculator classes.

getDefaultTextValue

java.lang.String getDefaultTextValue()

Value used like the default value for the text field.

Returns:

the default text value.

setDefaultTextValue

void setDefaultTextValue(java.lang.String textValue)

Set the default value for the text field.

Parameters:

textValue - the default text value.

getDefaultFontType

java.lang.String getDefaultFontType()

Value used like the default value for the font type field.

Returns:

the default font type value.

setDefaultFontType

void setDefaultFontType(java.lang.String fontType)

Set the default value for the font type field.

Parameters:

fontType - the default font type value.

getFontTypes

java.util.List<java.lang.String> getFontTypes()

Returns:

the list of possible values for the font type field.

addFontType

void addFontType(java.lang.String fontType)

It adds a new value for the font type field.

Parameters:

fontType - the new font type.

getDefaultFontStyle

java.lang.String getDefaultFontStyle()

Value used like the default value for the font style field.

Returns:

the default font style value.

setDefaultFontStyle

void setDefaultFontStyle(java.lang.String fontStyle)

Set the default value for the font style field.

Parameters:

fontStyle - the default font style value.

getFontStyles

java.util.List<java.lang.String> getFontStyles()

Returns:

the list of possible values for the font style field.

addFontStyle

void addFontStyle(java.lang.String fontStyle)

It adds a new value for the font style field.

Parameters:

fontStyle - the new font style.

getDefaultFontColor

int getDefaultFontColor()

Value used like the default value for the font color field.

Returns:

the default font color value.

setDefaultFontColor

void setDefaultFontColor(int fontColor)

Set the default value for the font color field.

Parameters:

fontColor - the default font color value.

setDefaultFontColor

void setDefaultFontColor(java.awt.Color fontColor)

Set the default value for the font color field.

Parameters:

fontColor - the default font color value.

getDefaultFontHeight

double getDefaultFontHeight()

Value used like the default value for the font height field.

Returns:

the default font height value.

setDefaultFontHeight

void setDefaultFontHeight(double fontHeight)

Set the default value for the font height field.

Parameters:

fontHeight - the default font height value.

getDefaultFontRotation

double getDefaultFontRotation()

Value used like the default value for the font rotation field.

Returns:

the default font rotation value.

setDefaultFontRotation

void setDefaultFontRotation(double fontRotation)

Set the default value for the font rotation field.

Parameters:

fontRotation - the default font rotation value.