org.gvsig.annotation

Interface AnnotationCreationService

All Superinterfaces:

CancellableTask, MonitorableTask

All Known Implementing Classes:

DefaultAnnotationCreationService

public interface AnnotationCreationService
extends MonitorableTask

This service is used to create an annotation layer.

It inherits if MonitorableTask, and it means that the annotation process can be monitorized by one or more observers that can listen all the export events.

Method Summary

Modifier and Type	Method and Description
FeatureStore	createAnnotationStore(java.lang.String destinationShapeFile, int textValueAttributeIndex) This method creates a FeatureStore with the annotations.
FeatureStore	createAnnotationStore(java.lang.String destinationShapeFile, java.lang.String textValueAttributeName) This method creates a FeatureStore with the annotations.
AnnotationCreationFinishAction	getAnnotationCreationFinishAction()
FeatureStore	getFeatureStore()
AnnotationManager	getManager() Returns the AnnotationManager
void	setAnnotationCreationFinishAction(AnnotationCreationFinishAction annotationCreationFinishAction) Sets the AnnotationCreationFinishAction that is used at the end of the annotation creation service.
void	setAnnotationPositionCalculator(AnnotationPositionCalculator annotationPositionCalculator) Sets an AnnotationPositionCalculator used to calculate the position of the
void	setFontColorAttribute(int index)
void	setFontColorAttribute(java.lang.String attributeName)
void	setFontHeigthAttribute(int index)
void	setFontHeigthAttribute(java.lang.String attributeName)
void	setFontRotationAttribute(int index)
void	setFontRotationAttribute(java.lang.String attributeName)
void	setFontStyleAttribute(int index)
void	setFontStyleAttribute(java.lang.String attributeName)
void	setFontTypeAttribute(int index)
void	setFontTypeAttribute(java.lang.String attributeName)

Methods inherited from interface org.gvsig.tools.task.MonitorableTask

getTaskStatus

Methods inherited from interface org.gvsig.tools.task.CancellableTask

cancelRequest, isCancellationRequested

Method Detail

getFeatureStore

FeatureStore getFeatureStore()

Returns:

the store that is used like input.

createAnnotationStore

FeatureStore createAnnotationStore(java.lang.String destinationShapeFile,
                                   int textValueAttributeIndex)
                            throws AnnotationCreationException

This method creates a FeatureStore with the annotations.

Parameters:

destinationShapeFile - path there the shape this the annotation information is created.

textValueAttributeIndex - attribute index of the original FeatureStore that contains the text.

Returns:

a new store with the annotation information.

Throws:

AnnotationCreationException - if there is an error creating the annotation store.

createAnnotationStore

FeatureStore createAnnotationStore(java.lang.String destinationShapeFile,
                                   java.lang.String textValueAttributeName)
                            throws AnnotationCreationException

This method creates a FeatureStore with the annotations.

Parameters:

destinationShapeFile - path there the shape this the annotation information is created.

textValueAttributeName - attribute name of the original FeatureStore that contains the text.

Returns:

a new store with the annotation information.

Throws:

AnnotationCreationException - if there is an error creating the annotation store.

setAnnotationCreationFinishAction

void setAnnotationCreationFinishAction(AnnotationCreationFinishAction annotationCreationFinishAction)

Sets the AnnotationCreationFinishAction that is used at the end of the annotation creation service.

Parameters:

annotationCreationFinishAction - it contains an action that can be executed at the end of the annotation creation process.

getAnnotationCreationFinishAction

AnnotationCreationFinishAction getAnnotationCreationFinishAction()

Returns:

the AnnotationCreationFinishAction used at the end of the annotation creation process.

setAnnotationPositionCalculator

void setAnnotationPositionCalculator(AnnotationPositionCalculator annotationPositionCalculator)

Sets an AnnotationPositionCalculator used to calculate the position of the

Parameters:

annotationPositionCalculator -

setFontTypeAttribute

void setFontTypeAttribute(int index)
                   throws DataException

Throws:

DataException

setFontStyleAttribute

void setFontStyleAttribute(int index)
                    throws DataException

Throws:

DataException

setFontColorAttribute

void setFontColorAttribute(int index)
                    throws DataException

Throws:

DataException

setFontHeigthAttribute

void setFontHeigthAttribute(int index)
                     throws DataException

Throws:

DataException

setFontRotationAttribute

void setFontRotationAttribute(int index)
                       throws DataException

Throws:

DataException

setFontTypeAttribute

void setFontTypeAttribute(java.lang.String attributeName)
                   throws DataException

Throws:

DataException

setFontStyleAttribute

void setFontStyleAttribute(java.lang.String attributeName)
                    throws DataException

Throws:

DataException

setFontColorAttribute

void setFontColorAttribute(java.lang.String attributeName)
                    throws DataException

Throws:

DataException

setFontHeigthAttribute

void setFontHeigthAttribute(java.lang.String attributeName)
                     throws DataException

Throws:

DataException

setFontRotationAttribute

void setFontRotationAttribute(java.lang.String attributeName)
                       throws DataException

Throws:

DataException

getManager

AnnotationManager getManager()

Returns the AnnotationManager

Returns:

AnnotationManager

See Also:

AnnotationManager}