Revision 41853 trunk/org.gvsig.desktop/org.gvsig.desktop.compat.cdc/org.gvsig.fmap.mapcontext/org.gvsig.fmap.mapcontext.api/src/main/java/org/gvsig/fmap/mapcontext/layers/FLayer.java
| FLayer.java | ||
|---|---|---|
| 53 | 53 |
|
| 54 | 54 |
|
| 55 | 55 |
/** |
| 56 |
* <p>Definition of the basic functionality that all kind of <i>FMap</i> layers should implement.</p>
|
|
| 57 |
* |
|
| 58 |
* <p>This kind of layers store their data, are drawable, projectable (with a projection), can be a node of a tree of layers, and
|
|
| 59 |
* could be editable and have a cache with previous draws. They also can be visible or not, and active or not.</p>
|
|
| 60 |
* |
|
| 61 |
* <p>A layer can also store information about errors produced working with it, and have a name (kind of layer) and
|
|
| 62 |
* a brief summary explaining what's for.</p>
|
|
| 63 |
* |
|
| 64 |
* <p>Each particular implementation can add new properties, and limit or expand the functionality.</p>
|
|
| 65 |
* |
|
| 56 |
* Definition of the basic functionality that all kind of layers should implement.
|
|
| 57 |
* <br>
|
|
| 58 |
* This kind of layers store their data, are drawable, projectable (with a projection), can be a node of a tree of layers, and |
|
| 59 |
* could be editable and have a cache with previous draws. They also can be visible or not, and active or not.
|
|
| 60 |
* <br>
|
|
| 61 |
* A layer can also store information about errors produced working with it, and have a name (kind of layer) and |
|
| 62 |
* a brief summary explaining what's for.
|
|
| 63 |
* <br>
|
|
| 64 |
* Each particular implementation can add new properties, and limit or expand the functionality.</p
|
|
| 65 |
* <br>
|
|
| 66 | 66 |
* @see Projected |
| 67 | 67 |
*/ |
| 68 | 68 |
public interface FLayer extends Projected, Persistent, Metadata, Disposable, ExtendedPropertiesSupport |
| ... | ... | |
| 73 | 73 |
public static final String METADATA_CRS = DataStore.METADATA_CRS; |
| 74 | 74 |
public static final String METADATA_NAME = "name"; |
| 75 | 75 |
|
| 76 |
|
|
| 77 |
// /** |
|
| 78 |
// * <p>Returns an entity that represents this layer.</p> |
|
| 79 |
// * |
|
| 80 |
// * <p>This XML entity has elements that represent and store information about this layer.</p> |
|
| 81 |
// * |
|
| 82 |
// * @return an XML entity with information of this layer |
|
| 83 |
// * @throws XMLException if there is an error obtaining the object. |
|
| 84 |
// * |
|
| 85 |
// * @see #setXMLEntity(XMLEntity) |
|
| 86 |
// * @see #setXMLEntity03(XMLEntity) |
|
| 87 |
// */ |
|
| 88 |
// XMLEntity getXMLEntity() throws XMLException; |
|
| 89 |
// |
|
| 90 |
// /** |
|
| 91 |
// * <p>Inserts information to this layer from an XML entity.</p> |
|
| 92 |
// * |
|
| 93 |
// * <p>This XML entity has elements that represent and store information about this layer.</p> |
|
| 94 |
// * |
|
| 95 |
// * @param xml an <code>XMLEntity</code> with the information |
|
| 96 |
// * |
|
| 97 |
// * @throws XMLException if there is an error setting the object. |
|
| 98 |
// * |
|
| 99 |
// * @see #getXMLEntity() |
|
| 100 |
// * @see #setXMLEntity03(XMLEntity) |
|
| 101 |
// */ |
|
| 102 |
// void setXMLEntity(XMLEntity xml) throws XMLException; |
|
| 103 |
|
|
| 104 | 76 |
/** |
| 105 | 77 |
* <p>Changes the status of this layer to active or inactive.</p> |
| 106 | 78 |
* <p>One layer is active if is selected in TOC.</p> |
| ... | ... | |
| 143 | 115 |
* <p>Executes the initialization operations of this layer. This method is invoked |
| 144 | 116 |
* only one time during the life of this layer and just before visualize it.</p> |
| 145 | 117 |
* |
| 146 |
* @throws org.gvsig.fmap.drivers.reading.DriverIOException if fails loading the layer.
|
|
| 118 |
* @throws LoadLayerException if fails loading the layer.
|
|
| 147 | 119 |
* |
| 148 | 120 |
* @see #reload() |
| 149 | 121 |
*/ |
| ... | ... | |
| 339 | 311 |
* @see #getMaxScale() |
| 340 | 312 |
*/ |
| 341 | 313 |
public void setMaxScale(double maxScale); |
| 342 |
/** |
|
| 343 |
* <p>Changes the status of this layer to editable or not.</p> |
|
| 344 |
* <p>One layer is editable if user can modify its information with graphical tools.</p> |
|
| 345 |
* |
|
| 346 |
* @param b the boolean to be set |
|
| 347 |
* |
|
| 348 |
* @throws com.iver.cit.gvsig.fmap.edition.EditionException if fails enabling for edition this kind of layer. |
|
| 349 |
* |
|
| 350 |
* @see #isEditing() |
|
| 351 |
* @deprecated Editing status is managed internally by layer, cannot be assigned here. |
|
| 352 |
*/ |
|
| 353 |
public void setEditing(boolean b) throws StartEditionLayerException; |
|
| 354 |
/** |
|
| 314 |
|
|
| 315 |
/** |
|
| 355 | 316 |
* <p>Returns if this layer is editable.</p> |
| 356 | 317 |
* <p>One layer is editable if user can modify its information with graphical tools.</p> |
| 357 | 318 |
* |
| ... | ... | |
| 432 | 393 |
/** |
| 433 | 394 |
* Adds an error reason that describes this layer's wrong status. |
| 434 | 395 |
* |
| 435 |
* @param error
|
|
| 396 |
* @param exception
|
|
| 436 | 397 |
* a <code>BaseException</code> with the information of the error |
| 437 | 398 |
* |
| 438 | 399 |
* @see #getNumErrors() |
| ... | ... | |
| 454 | 415 |
* <p>Changes the status of availability of this layer.</p> |
| 455 | 416 |
* <p>One layer is available if the source of data is on-line.</p> |
| 456 | 417 |
* |
| 457 |
* @param the boolean to be set |
|
| 418 |
* @param available the boolean to be set
|
|
| 458 | 419 |
* |
| 459 | 420 |
* @see #isAvailable() |
| 460 | 421 |
*/ |
| ... | ... | |
| 547 | 508 |
*/ |
| 548 | 509 |
Image getTocStatusImage(); |
| 549 | 510 |
|
| 550 |
// M?todos para la utilizaci?n de HyperLinks |
|
| 511 |
/** |
|
| 512 |
* <p>Sets the projection to this layer.</p> |
|
| 513 |
* |
|
| 514 |
* @param proj information about the new projection |
|
| 515 |
* |
|
| 516 |
*/ |
|
| 517 |
public void setProjection(IProjection proj); |
|
| 518 |
|
|
| 519 |
public long getDrawVersion(); |
|
| 551 | 520 |
|
| 521 |
public boolean isTemporary(); |
|
| 522 |
|
|
| 523 |
public void setTemporary(boolean temporary); |
|
| 524 |
|
|
| 525 |
/** |
|
| 526 |
* Do nothing. |
|
| 527 |
* |
|
| 528 |
* @param b |
|
| 529 |
* @throws org.gvsig.fmap.mapcontext.exceptions.StartEditionLayerException |
|
| 530 |
* @deprecated Editing status is managed internally by layer, cannot be assigned here. |
|
| 531 |
*/ |
|
| 532 |
public void setEditing(boolean b) throws StartEditionLayerException; |
|
| 533 |
|
|
| 552 | 534 |
/** |
| 553 |
* Returns information about if the layer allows HyperLink or not |
|
| 554 |
* @return boolean true if allows Link, false if not |
|
| 535 |
* Alwais return false |
|
| 536 |
* @return false |
|
| 537 |
* @deprecated see https://redmine.gvsig.net/redmine/projects/gvsig-hyperlink |
|
| 555 | 538 |
*/ |
| 556 | 539 |
public boolean allowLinks(); |
| 557 | 540 |
|
| 558 | 541 |
/** |
| 559 |
* Returns an instance of AbstractLinkProperties that contains the information
|
|
| 560 |
* of the HyperLink
|
|
| 561 |
* @return Abstra
|
|
| 542 |
* Alwais return null.
|
|
| 543 |
* @return null
|
|
| 544 |
* @deprecated see https://redmine.gvsig.net/redmine/projects/gvsig-hyperlink
|
|
| 562 | 545 |
*/ |
| 563 | 546 |
public AbstractLinkProperties getLinkProperties(); |
| 564 | 547 |
|
| 565 | 548 |
/** |
| 566 |
* Provides an array with URIs. Returns one URI by geometry that includes the point |
|
| 567 |
* in its own geometry limits with a allowed tolerance. |
|
| 568 |
* @param layer, the layer |
|
| 569 |
* @param point, the point to check that is contained or not in the geometries in the layer |
|
| 570 |
* @param tolerance, the tolerance allowed. Allowed margin of error to detect if the point |
|
| 571 |
* is contained in some geometries of the layer |
|
| 572 |
* @return |
|
| 573 |
* @throws ReadException |
|
| 574 |
* @throws BehaviorException |
|
| 549 |
* alwais return null |
|
| 550 |
* |
|
| 551 |
* @param point |
|
| 552 |
* @param tolerance |
|
| 553 |
* @return null |
|
| 554 |
* @throws org.gvsig.fmap.dal.exception.ReadException |
|
| 555 |
* @deprecated see https://redmine.gvsig.net/redmine/projects/gvsig-hyperlink |
|
| 575 | 556 |
*/ |
| 576 | 557 |
public URI[] getLink(Point2D point, double tolerance) throws ReadException; |
| 577 | 558 |
|
| 578 | 559 |
|
| 579 |
/** |
|
| 580 |
* <p>Inserts the projection to this layer.</p> |
|
| 581 |
* |
|
| 582 |
* @param proj information about the new projection |
|
| 583 |
* |
|
| 584 |
*/ |
|
| 585 |
public void setProjection(IProjection proj); |
|
| 586 |
|
|
| 587 |
public long getDrawVersion(); |
|
| 588 |
|
|
| 560 |
|
|
| 589 | 561 |
} |
Also available in: Unified diff