Revision 14305 trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/layers/layerOperations/InfoByPoint.java

View differences:

InfoByPoint.java
50 50

  
51 51

  
52 52
/**
53
 * Interfaz a implementar por las capas que soporten la
54
 * operaci?n de petici?n de informaci?n por punto y cuyo
55
 * resultado sea un string, pudiendo estar formateado como
56
 * un XML dicho resultado
53
 * <p>Interface that must implement the layers which support the operation "<i>information by point</i>".</p>
54
 * <p>That operation allows get meta-information from a point and an area around, of a layer or map.</p>
57 55
 */
58 56
public interface InfoByPoint {
59 57
	/**
60
	 * Realiza una consulta por punto en la capa
58
	 * <p>Executes a consultation about information of a point on the layer.</p>
59
	 * 
60
	 * <p>There is an area around the point where will get the information.</p>
61 61
	 *
62
	 * @param p Punto que se consulta
63
	 *
64
	 * @return String con el resultado en texto plano o en XML
65
	 * @throws ReadDriverException
66
	 * @throws VisitorException TODO
67
	 * @throws LoadLayerException
68
	 * @throws DriverException
62
	 * @param p point where is the consultation
63
	 * @param tolerance permissible margin around the coordinates of the point where the method will get the information. Each
64
	 *  singular implementation of this method would use it in a different way. The coordinates also depend on the implementation.
65
	 * @param cancel object that implements the {@link Cancellable Cancellable} interface, and that allows cancel the draw</code>
66
	 * 
67
	 * @return an array with XML items that have the information of that point
68
	 * 
69
	 * @throws DriverException any exception produced using the driver.
69 70
	 */
70 71
	public XMLItem[] getInfo(Point p, double tolerance, Cancellable cancel) throws ReadDriverException, VisitorException, LoadLayerException;
71 72
}

Also available in: Unified diff