Overview  Package   Class  Tree  Deprecated  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

org.apache.cocoon.components.xscript
Class XScriptManagerImpl

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.components.xscript.XScriptManagerImpl
All Implemented Interfaces:
org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.framework.parameters.Parameterizable, org.apache.avalon.framework.thread.ThreadSafe, XScriptManager
public class XScriptManagerImpl
extends org.apache.avalon.framework.logger.AbstractLoggable
implements XScriptManager, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.parameters.Parameterizable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.thread.ThreadSafe

The actual implementation of the XScriptManager interface.

Since:
August 4, 2001
Version:
CVS $Id: XScriptManagerImpl.java,v 1.6.2.3 2002/07/30 01:17:49 vgritsenko Exp $
Author:
Ovidiu Predescu

Field Summary
protected  Context context
          The Context instance.
static java.lang.String CONTEXT
           
protected  org.apache.avalon.framework.component.ComponentManager manager
          The ComponentManager instance.
 
Fields inherited from interface org.apache.cocoon.components.xscript.XScriptManager
ALL_SCOPES, GLOBAL_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, ROLE, SESSION_SCOPE, XSCRIPT_NS
 
Constructor Summary
XScriptManagerImpl()
           
 
Method Summary
 void compose(org.apache.avalon.framework.component.ComponentManager manager)
           
 void contextualize(org.apache.avalon.framework.context.Context context)
           
 XScriptObject get(XScriptVariableScope pageScope, java.util.Map objectModel, java.lang.String name, int scope)
          Obtains the object value of the name variable in scope.
 XScriptObject getFirst(XScriptVariableScope pageScope, java.util.Map objectModel, java.lang.String name)
          Search for the first occurence of the variable name.
 void parameterize(org.apache.avalon.framework.parameters.Parameters params)
           
 void put(XScriptVariableScope pageScope, java.util.Map objectModel, java.lang.String name, XScriptObject value, int scope)
          Defines or overwrites the value of variable name in scope.
 void register(XScriptObject object)
           
 XScriptObject remove(XScriptVariableScope pageScope, java.util.Map objectModel, java.lang.String name, int scope)
          Removes a variable previously declared in scope within context.
 XScriptObject removeFirst(XScriptVariableScope pageScope, java.util.Map objectModel, java.lang.String name)
          Remove the first appearance of name in the all the currently accessible scopes.
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable
getLogger, setLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTEXT

public static final java.lang.String CONTEXT

manager

protected org.apache.avalon.framework.component.ComponentManager manager
The ComponentManager instance.

context

protected Context context
The Context instance.
Constructor Detail

XScriptManagerImpl

public XScriptManagerImpl()
Method Detail

contextualize

public void contextualize(org.apache.avalon.framework.context.Context context)
                   throws org.apache.avalon.framework.context.ContextException
Specified by:
contextualize in interface org.apache.avalon.framework.context.Contextualizable

compose

public void compose(org.apache.avalon.framework.component.ComponentManager manager)
             throws org.apache.avalon.framework.component.ComponentException
Specified by:
compose in interface org.apache.avalon.framework.component.Composable

register

public void register(XScriptObject object)

parameterize

public void parameterize(org.apache.avalon.framework.parameters.Parameters params)
                  throws org.apache.avalon.framework.parameters.ParameterException
Specified by:
parameterize in interface org.apache.avalon.framework.parameters.Parameterizable

get

public XScriptObject get(XScriptVariableScope pageScope,
                         java.util.Map objectModel,
                         java.lang.String name,
                         int scope)
                  throws java.lang.IllegalArgumentException
Description copied from interface: XScriptManager
Obtains the object value of the name variable in scope. The context parameter is interpreted differently depending on the value of scope, as follows:
Specified by:
get in interface XScriptManager
Following copied from interface: org.apache.cocoon.components.xscript.XScriptManager
Parameters:
objectModel - an instance of Cocoon object model used to obtain context
name - a String value
scope - an int value
Returns:
a XScriptObject value

getFirst

public XScriptObject getFirst(XScriptVariableScope pageScope,
                              java.util.Map objectModel,
                              java.lang.String name)
                       throws java.lang.IllegalArgumentException
Description copied from interface: XScriptManager
Search for the first occurence of the variable name.

The search happens first in the session scope identified by sessionContext. If no variable is found here, the search continues in the page scope identified by pageContext. If no variable is found here, it's finally searched in the global scope.

The XScriptObject value of the variable is returned if a variable is found in one of the scopes, otherwise an exception is thrown.

Specified by:
getFirst in interface XScriptManager
Following copied from interface: org.apache.cocoon.components.xscript.XScriptManager
Parameters:
objectModel - an instance of Cocoon object model used to obtain context
name - a String value
Returns:
a XScriptObject value
Throws:
java.lang.IllegalArgumentException - if an error occurs

put

public void put(XScriptVariableScope pageScope,
                java.util.Map objectModel,
                java.lang.String name,
                XScriptObject value,
                int scope)
Description copied from interface: XScriptManager
Defines or overwrites the value of variable name in scope. The context argument is interpreted as described in XScriptManager.get(XScriptVariableScope, Map, String, int).
Specified by:
put in interface XScriptManager
Following copied from interface: org.apache.cocoon.components.xscript.XScriptManager
Parameters:
objectModel - an instance of Cocoon object model used to obtain context
name - a String value
value - a XScriptObject value
scope - an int value

remove

public XScriptObject remove(XScriptVariableScope pageScope,
                            java.util.Map objectModel,
                            java.lang.String name,
                            int scope)
                     throws java.lang.IllegalArgumentException
Description copied from interface: XScriptManager
Removes a variable previously declared in scope within context. Such a variable could be declared using the XScriptManager.put(XScriptVariableScope, Map, String, XScriptObject, int) method.
Specified by:
remove in interface XScriptManager
Following copied from interface: org.apache.cocoon.components.xscript.XScriptManager
Parameters:
objectModel - an instance of Cocoon object model used to obtain context
name - a String value
scope - an int value
Throws:
java.lang.IllegalArgumentException - if an error occurs

removeFirst

public XScriptObject removeFirst(XScriptVariableScope pageScope,
                                 java.util.Map objectModel,
                                 java.lang.String name)
                          throws java.lang.IllegalArgumentException
Description copied from interface: XScriptManager
Remove the first appearance of name in the all the currently accessible scopes. The search happens as described in XScriptManager.getFirst(XScriptVariableScope, Map, String).
Specified by:
removeFirst in interface XScriptManager
Following copied from interface: org.apache.cocoon.components.xscript.XScriptManager
Parameters:
objectModel - an instance of Cocoon object model used to obtain context
name - a String value
Throws:
java.lang.IllegalArgumentException - if an error occurs
Overview  Package   Class  Tree  Deprecated  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.