Application: gvSIG desktop

<?xml version="1.0" encoding="ISO-8859-1"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0

		 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.annotation.lib</artifactId>

	<packaging>pom</packaging>

	<name>org.gvsig.annotation.lib</name>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.annotation</artifactId>

		<version>1.0.0-SNAPSHOT</version>

	</parent>

	<modules>

		<module>org.gvsig.annotation.lib.api</module>

		<module>org.gvsig.annotation.lib.impl</module>

	</modules>

</project>

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.annotation;

import java.io.File;

import java.util.ArrayList;

import java.util.List;

import org.gvsig.fmap.crs.CRSFactory;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureSet;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.dal.feature.FeatureType;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.exception.CreateGeometryException;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.i18n.Messages;

import org.gvsig.tools.dispose.DisposableIterator;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

/**

 * API compatibility tests for {@link AnnotationCreationService} implementations.

 * 

 * @author gvSIG Team

 * @version $Id$

 */

public abstract class AnnotationCreationServiceTest extends

    AbstractLibraryAutoInitTestCase {

    protected AnnotationManager manager;

    protected DataManager dataManager;

    @Override

    protected void doSetUp() throws Exception {

        manager = AnnotationLocator.getManager();

        dataManager = DALLocator.getDataManager();

    }

    /**

     * Returns an instance of the {@link AnnotationCreationService}.

     * 

     * @return a {@link AnnotationCreationService} instance

     * @throws Exception

     *             if there is any error creating the instance

     */

    protected AnnotationCreationService createService() throws Exception {

    	String sourceFileName = getClass().getClassLoader().getResource("org/gvsig/annotation/data/andalucia.shp").getFile();

    	DataStoreParameters sourceParameters = dataManager.createStoreParameters("Shape");

     	sourceParameters.setDynValue("shpfile", sourceFileName);

     	sourceParameters.setDynValue("crs", CRSFactory.getCRS("EPSG:23030"));

     	FeatureStore sourceStore = (FeatureStore) dataManager.openStore("Shape", sourceParameters);

    	return manager.getAnnotationCreationService(sourceStore);

    }

    /**

     * Test for the {@link AnnotationCreationService#getMessage()} method.

     * 

     * @throws Exception

     *             if there is any error in the tests

     */

    public void testAnnotationServiceMessage() throws Exception {

        AnnotationCreationService annotationCreationService = createService();

        File temporalFolder = new File(System.getProperty("java.io.tmpdir") +  File.separator + "tmp_gvsig_annotation");

        if (!temporalFolder.exists()){

        	if (!temporalFolder.mkdir()){

        		throw new Exception("Impossible to create the destination folder");

        	}

        }

        String destinationFileName =  temporalFolder.getAbsolutePath() + File.separator + Math.random() + ".shp";		

        annotationCreationService.createAnnotationStore(destinationFileName, 1);

        DataStoreParameters destinationParameters = dataManager.createStoreParameters("Shape");

        destinationParameters.setDynValue("shpfile", destinationFileName);

        destinationParameters.setDynValue("crs", CRSFactory.getCRS("EPSG:23030"));

    	FeatureStore destinationStore = (FeatureStore) dataManager.openStore("Shape", destinationParameters);

    	assertNotNull(destinationStore);

    	FeatureType featureType = destinationStore.getDefaultFeatureType();

    	assertEquals(7, featureType.getAttributeDescriptors().length);

     	assertEquals(destinationStore.getFeatureCount(), annotationCreationService.getFeatureStore().getFeatureCount());

    	assertNotNull(featureType.getDefaultGeometryAttribute());

    	assertEquals(featureType.getDefaultGeometryAttribute().getGeometryType(), Geometry.TYPES.POINT);

    	//Check the geometries

    	FeatureSet featureSet = destinationStore.getFeatureSet();

    	DisposableIterator iterator = featureSet.iterator();

    	Feature feature;

    	TextPointPairList textPointPairList = getResult();

    	while (iterator.hasNext()){

    		feature = (Feature)iterator.next();

    		assertNotNull(feature.get(Messages.getText(AnnotationManager.TEXTVALUE_ATTRIBUTE_NAME)));

    		String text = feature.getString(AnnotationManager.TEXTVALUE_ATTRIBUTE_NAME);

    		TextPointPair textPointPair = textPointPairList.search(text);

    		if (textPointPair != null){

	    		//Check the geometry

	    		Point point = (Point)feature.getDefaultGeometry();

	    		assertEquals(point.getX(), textPointPair.getPoint().getX(), 0.01);

	    		assertEquals(point.getY(), textPointPair.getPoint().getY(), 0.01);

	    	}

    		int color = feature.getInt(AnnotationManager.FONTCOLOR_ATTRIBUTE_NAME);

    		assertEquals(color, manager.getDefaultFontColor()); 

    		double heigth = feature.getDouble(AnnotationManager.FONTHEGTH_ATTRIBUTE_NAME);

    		assertEquals(heigth, manager.getDefaultFontHeight()); 

    		double rotation = feature.getDouble(AnnotationManager.FONTROTATION_ATTRIBUTE_NAME);

    		assertEquals(rotation, manager.getDefaultFontRotation()); 

    		String type = feature.getString(AnnotationManager.FONTTYPE_ATTRIBUTE_NAME);

    		assertEquals(type, manager.getDefaultFontType()); 

    		String style = feature.getString(AnnotationManager.FONTSTYLE_ATTRIBUTE_NAME);

    		assertEquals(style, manager.getDefaultFontStyle());     		

    	}

    	destinationStore.dispose();

    	annotationCreationService.getFeatureStore().dispose();

    }

    public abstract TextPointPairList getResult() throws CreateGeometryException;

    public class TextPointPairList{

    	List<TextPointPair> textPointPairs = new ArrayList<TextPointPair>();

		public TextPointPairList() {

			super();

		}

		public void addPoint(String text, Point point){

			textPointPairs.add(new TextPointPair(text, point));

		}

		public TextPointPair search(String text){

			for (TextPointPair textPointPair : textPointPairs) {

				if (textPointPair.getText().equals(text)){

					return textPointPair;

				}

			}

			return null;

		}    	

    }

    private class TextPointPair{

    	private String text;

		private Point point;

    	public TextPointPair(String text, Point point) {

			super();

			this.text = text;

			this.point = point;

		}

    	public String getText() {

			return text;

		}

		public Point getPoint() {

			return point;

		}    	

    }

    /**

     * Test for the {@link AnnotationCreationService#getManager()} method.

     * 

     * @throws Exception

     *             if there is any error in the tests

     */

    public void testAnnotationServiceManager() throws Exception {

        AnnotationCreationService annotationCreationService = createService();

        assertEquals(manager, annotationCreationService.getManager());

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.annotation;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

/**

 * API compatibility tests for {@link AnnotationManager} implementations.

 * 

 * @author gvSIG Team

 * @version $Id$

 */

public abstract class AnnotationManagerTest extends

    AbstractLibraryAutoInitTestCase {

    protected AnnotationManager manager;

    @Override

    protected void doSetUp() throws Exception {

        manager = AnnotationLocator.getManager();

    }

    /**

     * Test for the {@link AnnotationManager#getAnnotationCreationService()}

     * method.

     * 

     * @throws Exception

     *             if there is any error in the tests

     */

    public void testGetAnnotationCreationService() throws Exception {

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.annotation;

/**

 * Exception thrown when there is an error creating an Annotation layer.

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class AnnotationCreationException extends AnnotationException {

    private static final long serialVersionUID = -4051458353306878010L;

    private static final String MESSAGE =

        "An error has been produced " + "creating the Annotation layer";

    private static final String KEY = "_AnnotationCreationException";

    /**

     * Creates a new {@link AnnotationCreationException}.

     * 

     * @param cause

     *            the original cause

     */

    public AnnotationCreationException(Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

    public AnnotationCreationException(String message) {

        super(message, KEY, serialVersionUID);

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Prodevelop}   {Task}

*/

package org.gvsig.annotation;

import org.gvsig.fmap.dal.feature.FeatureStore;

/**

 * Action that can be executed at the end of the annotation 

 * creation process. An example of action can be load the destination

 * {@link FeatureStore} like a layer in a view.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public interface AnnotationCreationFinishAction {

	/**

	 * This method is called at the end of an annotation

	 * creation process.

	 * @param featureStore

	 * the destination store.

	 */

	public void finished(FeatureStore featureStore);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.annotation;

import org.gvsig.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

/**

 * This locator is the entry point for the Annotation library, providing

 * access to all Annotation services through the {@link AnnotationManager}

 * .

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class AnnotationLocator extends BaseLocator {

    /**

     * Annotation manager name.

     */

    public static final String MANAGER_NAME = "Annotation.manager";

    /**

     * Annotation manager description.

     */

    public static final String MANAGER_DESCRIPTION = "Annotation Manager";

    private static final String LOCATOR_NAME = "Annotation.locator";

    /**

     * Unique instance.

     */

    private static final AnnotationLocator INSTANCE =

        new AnnotationLocator();

    /**

     * Return the singleton instance.

     * 

     * @return the singleton instance

     */

    public static AnnotationLocator getInstance() {

        return INSTANCE;

    }

    /**

     * Return the Locator's name.

     * 

     * @return a String with the Locator's name

     */

    public final String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Return a reference to the AnnotationManager.

     * 

     * @return a reference to the AnnotationManager

     * @throws LocatorException

     *             if there is no access to the class or the class cannot be

     *             instantiated

     * @see Locator#get(String)

     */

    public static AnnotationManager getManager() throws LocatorException {

        return (AnnotationManager) getInstance().get(MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the AnnotationManager interface.

     * 

     * @param clazz

     *            implementing the AnnotationManager interface

     */

    public static void registerManager(

        Class<? extends AnnotationManager> clazz) {

        getInstance().register(MANAGER_NAME, MANAGER_DESCRIPTION, clazz);

    }

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.annotation package documentation</title>

</head>

<body>

	<p>Annotation library API.</p>

	<p>

	It allows to get new Annotation and get their text.

	</p>

</body>

</html>

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Prodevelop}   {Task}

*/

package org.gvsig.annotation;

import org.gvsig.tools.service.ServiceException;

/**

 * Exception thrown by the {@link AnnotationCreationService}.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public class AnnotationCreationServiceException extends ServiceException {

	private static final long serialVersionUID = -4200816057552322619L;

	private final static String MESSAGE_KEY = "_AnnotationCreationServiceException";	

	public AnnotationCreationServiceException(String message, Throwable e) {

		super(message, e, MESSAGE_KEY, serialVersionUID);

		this.initCause(e);		

	}

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.annotation;

import org.gvsig.fmap.dal.DALLibrary;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.locator.ReferenceNotRegisteredException;

/**

 * Library for API initialization and configuration.

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class AnnotationLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        registerAsAPI(AnnotationLibrary.class);

        require(DALLibrary.class);

    }

	@Override

    protected void doInitialize() throws LibraryException {

        // Do nothing

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

    	// Validate there is any implementation registered.

        AnnotationManager manager = AnnotationLocator.getManager();

        if (manager == null) {

            throw new ReferenceNotRegisteredException(

                AnnotationLocator.MANAGER_NAME, AnnotationLocator

                    .getInstance());

        }

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.annotation;

import org.gvsig.annotation.calculator.AnnotationPositionCalculator;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.tools.task.MonitorableTask;

/**

 * <p>

 * This service is used to create an annotation layer.

 * </p>

 * <p>

 * It inherits if {@link MonitorableTask}, and it means that the annotation 

 * process can be monitorized by one or more observers that can listen

 * all the export events.

 * <p>

 * @author gvSIG team

 * @version $Id$

 */

public interface AnnotationCreationService extends MonitorableTask {

	/**

	 * @return

	 * the store that is used like input.

	 */

	public FeatureStore getFeatureStore();

	/**

	 * This method creates a {@link FeatureStore} with the annotations. 

	 * @param destinationShapeFile 

	 * path there the shape this the annotation information is created.

	 * @param textValueAttributeIndex

	 * attribute index of the original {@link FeatureStore} that contains the text.

	 * @return

	 * a new store with the annotation information.

	 * @throws AnnotationCreationException

	 * if there is an error creating the annotation store. 

	 */

    public FeatureStore createAnnotationStore(String destinationShapeFile, int textValueAttributeIndex) throws AnnotationCreationException;

    /**

	 * This method creates a {@link FeatureStore} with the annotations. 

	 * @param destinationShapeFile 

	 * path there the shape this the annotation information is created.

	 * @param textValueAttributeName

	 * attribute name of the original {@link FeatureStore} that contains the text.

	 * @return

	 * a new store with the annotation information.

	 * @throws AnnotationCreationException

	 * if there is an error creating the annotation store. 

	 */

    public FeatureStore createAnnotationStore(String destinationShapeFile, String textValueAttributeName) throws AnnotationCreationException;   

    /**

     * Sets the {@link AnnotationCreationFinishAction} that is used at the end

     * of the annotation creation service. 

     * @param annotationCreationFinishAction

     * it contains an action that can be executed at the end of the annotation

     * creation process.

     */

    public void setAnnotationCreationFinishAction(AnnotationCreationFinishAction annotationCreationFinishAction);

    /**

     * @return

     * the {@link AnnotationCreationFinishAction} used at the end of the annotation

     * creation process.

     */

    public AnnotationCreationFinishAction getAnnotationCreationFinishAction();

    /**

     * Sets an {@link AnnotationPositionCalculator} used to calculate the

     * position of the 

     * @param annotationPositionCalculator

     */

    public void setAnnotationPositionCalculator(AnnotationPositionCalculator annotationPositionCalculator);

    public void setFontTypetAttribute(int index) throws DataException;

    public void setFontStyleAttribute(int index) throws DataException;

    public void setFontColorAttribute(int index) throws DataException;

    public void setFontHeigthAttribute(int index) throws DataException;

    public void setFontRotationAttribute(int index) throws DataException;

    public void setFontTypetAttribute(String attributeName) throws DataException;

    public void setFontStyleAttribute(String attributeName) throws DataException;

    public void setFontColorAttribute(String attributeName) throws DataException;

    public void setFontHeigthAttribute(String attributeName) throws DataException;

    public void setFontRotationAttribute(String attributeName) throws DataException;

    /**

     * Returns the {@link AnnotationManager}

     * 

     * @return {@link AnnotationManager}

     * @see {@link AnnotationManager}

     */

    public AnnotationManager getManager();

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.annotation;

import java.awt.Color;

import java.util.List;

import org.gvsig.annotation.calculator.AnnotationPositionCalculator;

import org.gvsig.annotation.calculator.AnnotationPositionCalculatorCreationException;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.tools.service.ServiceException;

/**

 * 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

 * {@link AnnotationCreationService}s.

 * 

 * @see AnnotationCreationService

 * @author gvSIG team

 * @version $Id$

 */

public interface AnnotationManager {

	/**

	 * Name of the datastore attribute that contains the text

	 * of the annotation.

	 */

	public static final String TEXTVALUE_ATTRIBUTE_NAME = "Text";

	/**

	 * Name of the datastore attribute that contains the font type

	 * of the annotation.

	 */

	public static final String FONTTYPE_ATTRIBUTE_NAME = "FontType";

	/**

	 * Name of the datastore attribute that contains the font style

	 * of the annotation.

	 */

	public static final String FONTSTYLE_ATTRIBUTE_NAME = "FontStyle";

	/**

	 * Name of the datastore attribute that contains the font color

	 * of the annotation.

	 */

	public static final String FONTCOLOR_ATTRIBUTE_NAME = "FontColor";

	/**

	 * Name of the datastore attribute that contains the font rotation

	 * of the annotation.

	 */

	public static final String FONTROTATION_ATTRIBUTE_NAME = "Rotation";

	/**

	 * Name of the datastore attribute that contains the font heigth

	 * of the annotation.

	 */

	public static final String FONTHEGTH_ATTRIBUTE_NAME = "Heigth";

	/**

	 * Create an instance of a {@link AnnotationCreationService}.

	 * 

	 * @param the feature store that is used like input.

	 * @return {@link AnnotationCreationService}

	 * @throws ServiceException

	 *             if there is an error getting the service

	 */

	public AnnotationCreationService getAnnotationCreationService(FeatureStore featureStore)

	throws ServiceException;

	/**

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

	 * annotation.

	 * @param name

	 * The name used to register the class.

	 * @param annotationPositionCalculatorClass

	 * The class that is able to calculate an annotation point.

	 */

	public void registerAnnotationPositionCalculator(String name, Class annotationPositionCalculatorClass);

	/**

	 * It registers the default implementation of an {@link AnnotationPositionCalculator}

	 * class. It will be used by default if the user don't specify any of them.

	 * @param annotationPositionCalculatorClass

	 * A class that is able to calculate an annotation point.

	 */

	public void registerDefaultAnnotationPositionCalculator(Class annotationPositionCalculatorClass);

	/**

	 * It returns an object that can be used to create the point

	 * where the annotation is displayed.

	 * @param name

	 * the name used to register the class.

	 * @return

	 * a class that is able to calculate an annotation point.

	 * @throws AnnotationPositionCalculatorCreationException

	 * if is not possible to create the object.

	 */

	public AnnotationPositionCalculator getAnnotationPositionCalculator(String name) throws AnnotationPositionCalculatorCreationException;

	/**

	 * It returns the default {@link AnnotationPositionCalculator}.

	 * @return

	 * the default {@link AnnotationPositionCalculator}.

	 * @throws AnnotationPositionCalculatorCreationException

	 * if is not possible to create the object.

	 */

	public AnnotationPositionCalculator getDefaultAnnotationPositionCalculator() throws AnnotationPositionCalculatorCreationException;

	/**

	 * @return

	 * the list of the names used to register the {@link AnnotationPositionCalculator} classes.

	 */

	public List<String> getAnnotationPositionCalculatorList();

	/**

	 * Value used like the default value for the text field.

	 * @return

	 * the default text value.

	 */

	public String getDefaultTextValue();

	/**

	 * Set the default value for the text field.

	 * @param textValue

	 * the default text value.

	 */

	public void setDefaultTextValue(String textValue);

	/**

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

	 * @return

	 * the default font type value.

	 */

	public String getDefaultFontType();

	/**

	 * Set the default value for the font type field.

	 * @param fontType

	 * the default font type value.

	 */

	public void setDefaultFontType(String fontType);

	/**

	 * @return

	 * the list of possible values for the font type field.

	 */

	public List<String> getFontTypes();

	/**

	 * It adds a new value for the font type field.

	 * @param fontType

	 * the new font type.

	 */

	public void addFontType(String fontType);

	/**

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

	 * @return

	 * the default font style value.

	 */

	public String getDefaultFontStyle();

	/**

	 * Set the default value for the font style field.

	 * @param fontStyle

	 * the default font style value.

	 */

	public void setDefaultFontStyle(String fontStyle);

	/**

	 * @return

	 * the list of possible values for the font style field.

	 */

	public List<String> getFontStyles();

	/**

	 * It adds a new value for the font style field.

	 * @param fontStyle

	 * the new font style.

	 */

	public void addFontStyle(String fontStyle);

	/**

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

	 * @return

	 * the default font color value.

	 */

	public int getDefaultFontColor();

	/**

	 * Set the default value for the font color field.

	 * @param fontColor

	 * the default font color value.

	 */

	public void setDefaultFontColor(int fontColor);

	/**

	 * Set the default value for the font color field.

	 * @param fontColor

	 * the default font color value.

	 */

	public void setDefaultFontColor(Color fontColor);

	/**

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

	 * @return

	 * the default font height value.

	 */

	public double getDefaultFontHeight();

	/**

	 * Set the default value for the font height field.

	 * @param fontHeight

	 * the default font height value.

	 */

	public void setDefaultFontHeight(double fontHeight);

	/**

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

	 * @return

	 * the default font rotation value.

	 */

	public double getDefaultFontRotation();

	/**

	 * Set the default value for the font rotation field.

	 * @param fontRotation

	 * the default font rotation value.

	 */

	public void setDefaultFontRotation(double fontRotation);        

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {Prodevelop}   {Task}

 */

package org.gvsig.annotation;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.tools.dataTypes.DataTypes;

/**

 * DataTypes for the fields that are created in an annotation {@link DataStore}.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public class AnnotationDataTypes {

	public static int TEXT = DataTypes.STRING;

	public static int FONTROTATION = DataTypes.DOUBLE;

	public static int FONTCOLOR = DataTypes.INT;

	public static int FONTHEIGHT = DataTypes.DOUBLE;

	public static int FONTTYPE = DataTypes.STRING;

	public static int FONTSTYLE = DataTypes.STRING;

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.annotation;

import org.gvsig.tools.exception.BaseException;

/**

 * Generic exception thrown in the Annotation API when the exception or error

 * may be dealt by the program or the user of the program which is a client of

 * the Annotation API.

 * 

 * @see {@link AnnotationCreationService}

 * @see {@link AnnotationManager}

 * @author gvSIG team.

 * @version $Id$

 */

public class AnnotationException extends BaseException {

    private static final long serialVersionUID = 6756475060924237176L;

    private static final String MESSAGE =

        "An error has been produced in the Annotation library";

    private static final String KEY = "_AnnotationException";

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <strong>Don't use this constructor in child classes.</strong>

     */

    public AnnotationException() {

        super(MESSAGE, KEY, serialVersionUID);

    }

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <p>

     * <strong>Don't use this constructor in child classes.</strong>

     * </p>

     * 

     * @param cause

     *            the original cause of the exception

     */

    public AnnotationException(Exception cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

    /**

     * @see BaseException#BaseException(String, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected AnnotationException(String message, String key, long code) {

        super(message, key, code);

    }

    /**

     * @see BaseException#BaseException(String, Throwable, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param cause

     *            the original cause of the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected AnnotationException(String message, Throwable cause,

        String key, long code) {

        super(message, cause, key, code);

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Prodevelop}   {Task}

*/

package org.gvsig.annotation.calculator;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.geom.primitive.Point;

/**

 * This class calculates the position of an annotation layer. It has a 

 * method that calculates the {@link Point} where the annotation has to

 * be displayed.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public interface AnnotationPositionCalculator {

	/**

	 * This method returns the position where the annotation has to be displayed.

	 * @param feature 

	 * the feature that is used like input. 

	 * @return

	 * the point where the annotation is displayed.

	 * @throws AnnotationPositionCalculationException

	 * if there is an exception calculating the point

	 */

	public Point getAnnotationPosition(Feature feature) throws AnnotationPositionCalculationException;	

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Prodevelop}   {Task}

*/

package org.gvsig.annotation.calculator;

import org.gvsig.annotation.AnnotationException;

/**

 * This exception is thrown if there is a problem calculating the

 * point where the annotation has to be displayed.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public class AnnotationPositionCalculationException extends AnnotationException {

	private static final long serialVersionUID = -2759803769427383259L;

	private static final String MESSAGE =

        "An error has been produced calculating the annotation position";

    private static final String KEY = "_AnnotationPositionCalculationException";

    /**

     * Creates a new {@link AnnotationPositionCalculationException}.

     * 

     * @param cause

     *            the original cause

     */

    public AnnotationPositionCalculationException(Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Prodevelop}   {Task}

*/

package org.gvsig.annotation.calculator;

import org.gvsig.annotation.AnnotationException;

/**

 * This exception is thrown if it is not possible to create an

 * {@link AnnotationPositionCalculator} object.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public class AnnotationPositionCalculatorCreationException extends AnnotationException {

	private static final long serialVersionUID = 8725010909175451070L;

	private String name = null;

	private static final String MESSAGE =

        "An error has been produced creating the %(name) AnnotationPositionCalculator";

    private static final String KEY = "_CreationAnnotationPositionCalculatoException";

    /**

     * Creates a new {@link AnnotationPositionCalculatorCreationException}.

     * 

     * @param cause

     *            the original cause

     */

    public AnnotationPositionCalculatorCreationException(String name, Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

        setValue("name", name);

    }      

}