deegree 2.3 (2010/04/09 10:10 build-4-official)

org.deegree.portal.portlet.modules.actions
Class IGeoPortalPortletPerform

java.lang.Object
  extended by org.deegree.portal.portlet.modules.actions.AbstractPortletPerform
      extended by org.deegree.portal.portlet.modules.actions.IGeoPortalPortletPerform
Direct Known Subclasses:
CoordsPortletPerform, CRSChooserPortletPerform, EnterBBOXPortletPerform, FeatureInfoPortletPerform, LayerListViewPortletPerform, LayerTreePortletPerform, MapActionPortletPerform, MapWindowPortletPerform, OverviewPortletPerform, RemoveAnnotationPerform, ScaleChooserPortletPerform, SelectWMCPortletPerform, WFSClientPortletPerform, WMCManagementPortletPerfom

public class IGeoPortalPortletPerform
extends AbstractPortletPerform

Version:
$Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18. Jun 2009) $
Author:
Andreas Poth, last edited by: $Author: mschneider $

Field Summary
static String PARAM_BBOX
          A String denoting BBOX
static String PARAM_LAYER
          A String denoting LAYER
static String PARAM_MAPMODE
          A String denoting MAPMODE
static String PARAM_SESSIONID
          A String denoting SESSIONID
static String PARAM_STYLE
          A String denoting STYLE
protected  javax.servlet.ServletContext sc
           
static String SESSION_HISTORY
          A String denoting HISTORY
static String SESSION_HISTORYPOSITION
          A String denoting HISTORYPOSITION
protected static Map<String,ViewContext> vcMap
           
 
Fields inherited from class org.deegree.portal.portlet.modules.actions.AbstractPortletPerform
AVAILABLE_WMC, CURRENT_WMC, CURRENT_WMC_NAME, INIT_MAPPORTLETID, INIT_WMC, PARAM_MAPACTION, PARAM_MAPPORTLET, PARAM_MODE, parameter, portlet, request, SESSION_CURRENTFILAYER, SESSION_HOME, SESSION_VIEWCONTEXT
 
Constructor Summary
IGeoPortalPortletPerform(javax.servlet.http.HttpServletRequest request, org.apache.jetspeed.portal.Portlet portlet, javax.servlet.ServletContext sc)
           
 
Method Summary
static String getCurrentMapContextName(javax.servlet.http.HttpSession session, String pid)
          returns the name of the current WMC into the users session
 String getCurrentMapContextName(String pid)
          returns the name of the current WMC into the users session
static ViewContext getCurrentViewContext(javax.servlet.http.HttpSession session, String pid)
          returns the current <@link ViewContext> read from the portlet session.
 ViewContext getCurrentViewContext(String pid)
          returns the current <@link ViewContext> read from the portlet session.
 ViewContext getNamedViewContext(javax.servlet.http.HttpSession session, String name)
          returns an instance of <@link ViewContext> read from the portlet session.
 ViewContext getNamedViewContext(String name)
          returns an instance of <@link ViewContext> read from the portlet session.
 void setBoundingBox(Envelope env)
          sets a new bounding box of the map read from the the request object passed when initialized an instance of MapWindowPortletPerfom
 void setBoundingBox(String bbox)
          the method expects a string with four comma seperated coordinate values.
 void setBoundingBoxFromBBOXParam()
          sets a new bounding box of the map read from the the request object passed when initialized an instance of MapWindowPortletPerfom
static void setCurrentMapContext(javax.servlet.http.HttpSession session, ViewContext vc, String pid)
          sets the current MapContext to the users session
 void setCurrentMapContext(ViewContext vc, String pid)
          sets the current MapContext to the users session
static void setCurrentMapContextName(javax.servlet.http.HttpSession session, String pid, String name)
          writes the name of the current WMC into the users session
 void setCurrentMapContextName(String pid, String name)
          writes the name of the current WMC into the users session
 void setLayers()
          sets layers of the view context as visible or invisble depending on the incoming request
 void setMode()
          writes the current map mode (if set) into the users WMC.
static void setNameContext(javax.servlet.http.HttpSession session, String name, URL url)
          writes the URL to a WMC with a assigend name into a users session
 void setNameContext(String name, URL url)
          writes the URL to a WMC with a assigend name into a users session
 void updateContext()
          updates the view context with the current bounding box, the list of visible layers and the current map mode
 
Methods inherited from class org.deegree.portal.portlet.modules.actions.AbstractPortletPerform
buildNormalContext, getInitParam, getMapPortletID, readMapContextID_
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAM_BBOX

public static final String PARAM_BBOX
A String denoting BBOX

See Also:
Constant Field Values

PARAM_LAYER

public static final String PARAM_LAYER
A String denoting LAYER

See Also:
Constant Field Values

PARAM_STYLE

public static final String PARAM_STYLE
A String denoting STYLE

See Also:
Constant Field Values

PARAM_MAPMODE

public static final String PARAM_MAPMODE
A String denoting MAPMODE

See Also:
Constant Field Values

PARAM_SESSIONID

public static final String PARAM_SESSIONID
A String denoting SESSIONID

See Also:
Constant Field Values

SESSION_HISTORY

public static final String SESSION_HISTORY
A String denoting HISTORY

See Also:
Constant Field Values

SESSION_HISTORYPOSITION

public static final String SESSION_HISTORYPOSITION
A String denoting HISTORYPOSITION

See Also:
Constant Field Values

sc

protected javax.servlet.ServletContext sc

vcMap

protected static Map<String,ViewContext> vcMap
Constructor Detail

IGeoPortalPortletPerform

public IGeoPortalPortletPerform(javax.servlet.http.HttpServletRequest request,
                                org.apache.jetspeed.portal.Portlet portlet,
                                javax.servlet.ServletContext sc)
Parameters:
request -
portlet -
sc - context
Method Detail

updateContext

public void updateContext()
updates the view context with the current bounding box, the list of visible layers and the current map mode


setLayers

public void setLayers()
sets layers of the view context as visible or invisble depending on the incoming request


setMode

public void setMode()
writes the current map mode (if set) into the users WMC.


setBoundingBoxFromBBOXParam

public void setBoundingBoxFromBBOXParam()
sets a new bounding box of the map read from the the request object passed when initialized an instance of MapWindowPortletPerfom


setBoundingBox

public void setBoundingBox(Envelope env)
sets a new bounding box of the map read from the the request object passed when initialized an instance of MapWindowPortletPerfom

Parameters:
env - new bounding box

setBoundingBox

public void setBoundingBox(String bbox)
the method expects a string with four comma seperated coordinate values. The created box will be written

Parameters:
bbox -

getCurrentViewContext

public static ViewContext getCurrentViewContext(javax.servlet.http.HttpSession session,
                                                String pid)
returns the current <@link ViewContext> read from the portlet session.

Parameters:
session -
pid - MapWindowPortlet id
Returns:
the current ViewContext read from the portlet session.

getCurrentViewContext

public ViewContext getCurrentViewContext(String pid)
returns the current <@link ViewContext> read from the portlet session.

Parameters:
pid - MapWindowPortlet id
Returns:
the current ViewContext read from the portlet session.

setCurrentMapContext

public static void setCurrentMapContext(javax.servlet.http.HttpSession session,
                                        ViewContext vc,
                                        String pid)
sets the current MapContext to the users session

Parameters:
session -
vc -
pid -

setCurrentMapContext

public void setCurrentMapContext(ViewContext vc,
                                 String pid)
sets the current MapContext to the users session

Parameters:
vc -
pid -

setCurrentMapContextName

public static void setCurrentMapContextName(javax.servlet.http.HttpSession session,
                                            String pid,
                                            String name)
writes the name of the current WMC into the users session

Parameters:
session -
pid -
name -

setCurrentMapContextName

public void setCurrentMapContextName(String pid,
                                     String name)
writes the name of the current WMC into the users session

Parameters:
pid -
name -

getCurrentMapContextName

public static String getCurrentMapContextName(javax.servlet.http.HttpSession session,
                                              String pid)
returns the name of the current WMC into the users session

Parameters:
session -
pid -
Returns:
the name of the current WMC into the users session

getCurrentMapContextName

public String getCurrentMapContextName(String pid)
returns the name of the current WMC into the users session

Parameters:
pid -
Returns:
the name of the current WMC into the users session

getNamedViewContext

public ViewContext getNamedViewContext(javax.servlet.http.HttpSession session,
                                       String name)
returns an instance of <@link ViewContext> read from the portlet session. If no instance is available null will be returned.

Parameters:
session -
name - map context name/id
Returns:
an instance of ViewContext read from the portlet session. If no instance is available null will be returned.

getNamedViewContext

public ViewContext getNamedViewContext(String name)
returns an instance of <@link ViewContext> read from the portlet session. If no instance is available null will be returned.

Parameters:
name - map context name/id
Returns:
instance of ViewContext read from the portlet session. If no instance is available null will be returned.

setNameContext

public static void setNameContext(javax.servlet.http.HttpSession session,
                                  String name,
                                  URL url)
writes the URL to a WMC with a assigend name into a users session

Parameters:
session -
name -
url -

setNameContext

public void setNameContext(String name,
                           URL url)
writes the URL to a WMC with a assigend name into a users session

Parameters:
name -
url -

deegree 2.3 (2010/04/09 10:10 build-4-official)

an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://www.deegree.org