Application: gvSIG desktop » gvSIG tools: Vector editing

/*

 * Copyright 2014 DiSiD Technologies S.L.L. All rights reserved.

 * 

 * Project  : DiSiD org.gvsig.vectorediting.lib.api 

 * SVN Id   : $Id$

 */

package org.gvsig.vectorediting.lib.api;

import java.awt.Image;

import java.util.List;

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

import org.gvsig.vectorediting.lib.api.exceptions.ServiceInformationException;

/**

 * 

 * 

 * 

 * @author gvSIG team.

 *

 */

public interface EditingServiceInfo {

  /**

   * Return if service creates new geometries.

   * 

   * @return true if service creates new geometries otherwise false. 

   */

  public boolean createsNewGeometries();

  /**

   * Get mouse icon associated.

   * 

   * @return Image that represents mouse icon.

   */

  public Image getMouseIcon();

  /**

   * Gets a <code>List</code> with all parameters of service. Each parameter has

   * name, description and types. See {@link EditingServiceParameter}.

   * 

   * @return A list of {@link EditingServiceParameter} objects.

   */

  public List<EditingServiceParameter> getParameters();

  /**

   * Gets supported primitive geometry types of service. 

   * 

   * @return

   */

  public int[] getSupportedPrimitiveGeometryTypes();

  /**

   * Gets description of service.

   * 

   * @return Description of service.

   */

  public String getDescription();

  /**

   * Gets name of service

   * 

   * @return service name.

   */

  public String getName();

  /**

   * Gets read only information about a parameter of this service. 

   * 

   * @param name Name of parameter.

   * @return An {@link EditingServiceParameter} object of parameter.

   */

  public EditingServiceParameter getParameterInfo(String name);

  /**

   * Returns if service is compatible with the feature store received as parameter.

   * 

   * @param featureStore 

   * @return True if service is compatible otherwise false.

   */

  public boolean isCompatibleWith(FeatureStore featureStore) throws ServiceInformationException;

}