de.cismet.cismap.commons

Class HeadlessMapProvider

java.lang.Object

de.cismet.cismap.commons.HeadlessMapProvider

public class HeadlessMapProvider
extends Object

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

thorsten

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeadlessMapProvider.DominatingDimension DOCUMENT ME!
static class	HeadlessMapProvider.NotificationLevel DOCUMENT ME!
class	HeadlessMapProvider.NotificationMessage DOCUMENT ME!
static class	HeadlessMapProvider.RoundingPrecision DOCUMENT ME!

Constructor Summary

Constructors

Constructor and Description
HeadlessMapProvider() Creates a new HeadlessMapProvider object.

Method Summary

Modifier and Type	Method and Description
void	addFeature(Feature f) add a feature to the HeadlessMapProvider.
void	addFeatures(Collection<? extends Feature> featureCollection) add a collection of features to the HeadlessMapProvider.
void	addLayer(RetrievalServiceLayer layer) Add a layer to the HeadlessMapProvider.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener that will notify about the progress of the map building.
static HeadlessMapProvider	createHeadlessMapProviderAndAddLayers(MappingComponent mappingComponent) Creates a HeadlessMapProvider and adds the raster layers and feature layers from the mapping component to it.
BoundingBox	getCurrentBoundingBoxFromMap() DOCUMENT ME!
HeadlessMapProvider.DominatingDimension	getDominatingDimension() The dominating dimension determines, what value is changed, when the image pixel ratio is adjusted to the coordinate ratio.
double	getFeatureResolutionFactor() DOCUMENT ME!
Image	getImage(int dpi, double widthInMillimeters, double heightInMilimeters) Don't know what the idea was behind this method ;-) maybe take the 72dpi from jasper and recalculate the pixels then call the next method.
Future<Image>	getImage(int widthPixels, int heightPixels) this is the most important function.
Future<Image>	getImage(int baseDpi, int targetDpi, double widthInPixels, double heightInPixels) This is the method called when you need to fill in a report: for jasper with (72 as basedpi and widzth and height with the dimension of the image in the report
Image	getImageAndWait(int widthPixels, int heightPixels) Generates the image and waits for the result.
Image	getImageAndWait(int basedpi, int targetDpi, double widthInPixels, double heightInPixels) This is the method called when you need to fill in a report: for jasper with (72 as basedpi and widzth and height with the dimension of the image in the report.
double	getImageScaleDenominator() DOCUMENT ME!
MappingComponent	getMappingComponent() DOCUMENT ME!
double	getPrintingResolution() DOCUMENT ME!
Object	getRequestingObject() DOCUMENT ME!
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener that will notify about the progress of the map building.
void	setBoundingBox(XBoundingBox boundingBox) set the bounding box of the HeadlessMapProvider.
void	setCenterMapOnResize(boolean b) DOCUMENT ME!
void	setCrs(Crs crs) DOCUMENT ME!
void	setDominatingDimension(HeadlessMapProvider.DominatingDimension dominatingDimension) Set the dominating dimension.
void	setFeatureResolutionFactor(double featureResolutionFactor) DOCUMENT ME!
void	setMinimumScaleDenomimator(double minimumScaleDenominator) DOCUMENT ME!
void	setPrintingResolution(double printingResolution) DOCUMENT ME!
void	setRequestingObject(Object requestingObject) DOCUMENT ME!
void	setRoundScaleTo(HeadlessMapProvider.RoundingPrecision rp) DOCUMENT ME!

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeadlessMapProvider

public HeadlessMapProvider()

Creates a new HeadlessMapProvider object.

Method Detail

getRequestingObject

public Object getRequestingObject()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setRequestingObject

public void setRequestingObject(Object requestingObject)

DOCUMENT ME!

Parameters:

requestingObject - DOCUMENT ME!

getFeatureResolutionFactor

public double getFeatureResolutionFactor()

DOCUMENT ME!

Returns:

the featureResolutionFactor

setFeatureResolutionFactor

public void setFeatureResolutionFactor(double featureResolutionFactor)

DOCUMENT ME!

Parameters:

featureResolutionFactor - the featureResolutionFactor to set

createHeadlessMapProviderAndAddLayers

public static HeadlessMapProvider createHeadlessMapProviderAndAddLayers(MappingComponent mappingComponent)

Creates a HeadlessMapProvider and adds the raster layers and feature layers from the mapping component to it.

Parameters:

mappingComponent - DOCUMENT ME!

Returns:

DOCUMENT ME!

getPrintingResolution

public double getPrintingResolution()

DOCUMENT ME!

Returns:

the printingResolution

setPrintingResolution

public void setPrintingResolution(double printingResolution)

DOCUMENT ME!

Parameters:

printingResolution - the printingResolution to set

getMappingComponent

public MappingComponent getMappingComponent()

DOCUMENT ME!

Returns:

DOCUMENT ME!

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a PropertyChangeListener that will notify about the progress of the map building.

Parameters:

listener - the listener to add

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener that will notify about the progress of the map building.

Parameters:

listener - the listener to remove

addFeature

public void addFeature(Feature f)

add a feature to the HeadlessMapProvider.

Parameters:

f - the feature to add

addFeatures

public void addFeatures(Collection<? extends Feature> featureCollection)

add a collection of features to the HeadlessMapProvider.

Parameters:

featureCollection - the feature collection to add

addLayer

public void addLayer(RetrievalServiceLayer layer)

Add a layer to the HeadlessMapProvider. A clone of the given layer is added to the model.

Parameters:

layer - the layer to add

setBoundingBox

public void setBoundingBox(XBoundingBox boundingBox)

set the bounding box of the HeadlessMapProvider.

Parameters:

boundingBox - the new BoundingBox of the map

setCrs

public void setCrs(Crs crs)

DOCUMENT ME!

Parameters:

crs - DOCUMENT ME!

getImage

public Image getImage(int dpi,
                      double widthInMillimeters,
                      double heightInMilimeters)

Don't know what the idea was behind this method ;-) maybe take the 72dpi from jasper and recalculate the pixels then call the next method.

Parameters:

dpi - DOCUMENT ME!

widthInMillimeters - DOCUMENT ME!

heightInMilimeters - DOCUMENT ME!

Returns:

DOCUMENT ME!

getImage

public Future<Image> getImage(int baseDpi,
                              int targetDpi,
                              double widthInPixels,
                              double heightInPixels)

This is the method called when you need to fill in a report: for jasper with (72 as basedpi and widzth and height with the dimension of the image in the report

Parameters:

baseDpi - DOCUMENT ME!

targetDpi - DOCUMENT ME!

widthInPixels - DOCUMENT ME!

heightInPixels - DOCUMENT ME!

Returns:

DOCUMENT ME!

getImage

public Future<Image> getImage(int widthPixels,
                              int heightPixels)

this is the most important function. all other getImage functions will call this function

Parameters:

widthPixels - DOCUMENT ME!

heightPixels - DOCUMENT ME!

Returns:

A future object that can provide an image

getImageAndWait

public Image getImageAndWait(int widthPixels,
                             int heightPixels)
                      throws ExecutionException,
                             InterruptedException

Generates the image and waits for the result. This method does not work in edt.

Parameters:

widthPixels - DOCUMENT ME!

heightPixels - DOCUMENT ME!

Returns:

An image of the map

Throws:

ExecutionException - DOCUMENT ME!

InterruptedException - DOCUMENT ME!

getImageAndWait

public Image getImageAndWait(int basedpi,
                             int targetDpi,
                             double widthInPixels,
                             double heightInPixels)
                      throws ExecutionException,
                             InterruptedException

This is the method called when you need to fill in a report: for jasper with (72 as basedpi and widzth and height with the dimension of the image in the report.

Parameters:

basedpi - DOCUMENT ME!

targetDpi - DOCUMENT ME!

widthInPixels - DOCUMENT ME!

heightInPixels - DOCUMENT ME!

Returns:

An image of the map

Throws:

ExecutionException - DOCUMENT ME!

InterruptedException - DOCUMENT ME!

getDominatingDimension

public HeadlessMapProvider.DominatingDimension getDominatingDimension()

The dominating dimension determines, what value is changed, when the image pixel ratio is adjusted to the coordinate ratio.

Returns:

the dominatingDimension

setDominatingDimension

public void setDominatingDimension(HeadlessMapProvider.DominatingDimension dominatingDimension)

Set the dominating dimension. The dominating dimension determines, what value is changed, when the image pixel ratio will be adjusted to the coordinate ratio

Parameters:

dominatingDimension - the dominatingDimension to set

setMinimumScaleDenomimator

public void setMinimumScaleDenomimator(double minimumScaleDenominator)

DOCUMENT ME!

Parameters:

minimumScaleDenominator - DOCUMENT ME!

setCenterMapOnResize

public void setCenterMapOnResize(boolean b)

DOCUMENT ME!

Parameters:

b - DOCUMENT ME!

setRoundScaleTo

public void setRoundScaleTo(HeadlessMapProvider.RoundingPrecision rp)

DOCUMENT ME!

Parameters:

rp - DOCUMENT ME!

getImageScaleDenominator

public double getImageScaleDenominator()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getCurrentBoundingBoxFromMap

public BoundingBox getCurrentBoundingBoxFromMap()

DOCUMENT ME!

Returns:

DOCUMENT ME!