Interface PlacemarkDescriptor
-
- All Known Implementing Classes:
AbstractPlacemarkDescriptor
,GcpDescriptor
,GenericPlacemarkDescriptor
,GeometryDescriptor
,PinDescriptor
,PointDescriptor
,PointPlacemarkDescriptor
,TrackPointDescriptor
public interface PlacemarkDescriptor
Placemark descriptors are used to describe and createPlacemark
s.New placemark descriptors can be added by using the Service Provider Interface
META-INF/services/PlacemarkDescriptor
.Since this interface is likely to change, clients should not directly implement it. Instead they should derive their implementation from
AbstractPlacemarkDescriptor
.- Since:
- BEAM 2.0 (full revision since BEAM 4.10)
- Version:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Placemark
createPlacemark(org.opengis.feature.simple.SimpleFeature feature)
Creates a new placemark by wrapping the given feature.org.opengis.feature.simple.SimpleFeatureType
getBaseFeatureType()
Gets the feature type that provides the minimum set of attributes required for this placemark descriptor.DecodeQualification
getCompatibilityFor(org.opengis.feature.simple.SimpleFeatureType featureType)
Gets the compatibility for the givenfeatureType
with respect to the placemarks created by this descriptor.Point
getCursorHotSpot()
Deprecated.Image
getCursorImage()
Deprecated.PlacemarkGroup
getPlacemarkGroup(Product product)
Deprecated.String
getRoleLabel()
Deprecated.String
getRoleName()
Deprecated.String
getShowLayerCommandId()
Deprecated.void
setUserDataOf(org.opengis.feature.simple.SimpleFeatureType compatibleFeatureType)
Asks the descriptor to set any application specific information in the feature type's user data.GeoPos
updateGeoPos(GeoCoding geoCoding, PixelPos pixelPos, GeoPos geoPos)
Deprecated.PixelPos
updatePixelPos(GeoCoding geoCoding, GeoPos geoPos, PixelPos pixelPos)
Deprecated.
-
-
-
Method Detail
-
createPlacemark
Placemark createPlacemark(org.opengis.feature.simple.SimpleFeature feature)
Creates a new placemark by wrapping the given feature.- Parameters:
feature
- The feature to be wrapped.- Returns:
- The new placemark.
-
setUserDataOf
void setUserDataOf(org.opengis.feature.simple.SimpleFeatureType compatibleFeatureType)
Asks the descriptor to set any application specific information in the feature type's user data. When called, the framework has already classified the given feature type as beingDecodeQualification.INTENDED
orDecodeQualification.SUITABLE
by consulting the methodgetCompatibilityFor(org.opengis.feature.simple.SimpleFeatureType)
.Implementors of this method may consider setting specific user data that allows
getCompatibilityFor(org.opengis.feature.simple.SimpleFeatureType)
to returnDecodeQualification.INTENDED
after e.g. data has been deserialized from a persistent data store.- Parameters:
compatibleFeatureType
- A compatible feature type whose user data may or may not be altered.
-
getCompatibilityFor
DecodeQualification getCompatibilityFor(org.opengis.feature.simple.SimpleFeatureType featureType)
Gets the compatibility for the givenfeatureType
with respect to the placemarks created by this descriptor.The method shall only return
DecodeQualification.INTENDED
, if the descriptor was designed for interpreting the given feature type, e.g. by inspecting thefeatureType
's user data which may be set bysetUserDataOf(org.opengis.feature.simple.SimpleFeatureType)
.The method may return
DecodeQualification.SUITABLE
, if thecreatePlacemark(org.opengis.feature.simple.SimpleFeature)
method can successfully create a new placemark from a feature having the compatiblefeatureType
.- Parameters:
featureType
- The feature type to be tested.- Returns:
true
, if thefeatureType
is compatible.
-
getBaseFeatureType
org.opengis.feature.simple.SimpleFeatureType getBaseFeatureType()
Gets the feature type that provides the minimum set of attributes required for this placemark descriptor.- Returns:
- The base feature type.
-
getRoleName
@Deprecated String getRoleName()
Deprecated.
-
getRoleLabel
@Deprecated String getRoleLabel()
Deprecated.
-
getPlacemarkGroup
@Deprecated PlacemarkGroup getPlacemarkGroup(Product product)
Deprecated.
-
updatePixelPos
@Deprecated PixelPos updatePixelPos(GeoCoding geoCoding, GeoPos geoPos, PixelPos pixelPos)
Deprecated.
-
updateGeoPos
@Deprecated GeoPos updateGeoPos(GeoCoding geoCoding, PixelPos pixelPos, GeoPos geoPos)
Deprecated.
-
getShowLayerCommandId
@Deprecated String getShowLayerCommandId()
Deprecated.
-
getCursorImage
@Deprecated Image getCursorImage()
Deprecated.
-
getCursorHotSpot
@Deprecated Point getCursorHotSpot()
Deprecated.
-
-