org.objectweb.proactive.core.component
Class ContentDescription

java.lang.Object
  extended byorg.objectweb.proactive.core.component.ContentDescription

public class ContentDescription
extends java.lang.Object

Fractal implementation-specific description of the content of components. With ProActive, features such as activity, factory, virtual node or constructor parameters can be specified.

Author:
Matthieu Morel

Constructor Summary
ContentDescription(java.lang.String className)
          constructor.
ContentDescription(java.lang.String className, java.lang.Object[] constructorParameters)
          constructor
ContentDescription(java.lang.String className, java.lang.Object[] constructorParameters, Node node)
          constructor
ContentDescription(java.lang.String className, java.lang.Object[] constructorParameters, Node node, Active activity, MetaObjectFactory factory)
          constructor
ContentDescription(java.lang.String className, java.lang.Object[] constructorParameters, VirtualNode virtualNode)
          constructor
ContentDescription(java.lang.String className, java.lang.Object[] constructorParameters, VirtualNode virtualNode, Active activity, MetaObjectFactory factory)
          constructor
 
Method Summary
 void forceSingleInstance()
           
 Active getActivity()
          getter for the activity
 java.lang.String getClassName()
          getter for the classname
 java.lang.Object[] getConstructorParameters()
          getter for the constructor parameters
 MetaObjectFactory getFactory()
          getter for the metaobjects factory
 Node getNode()
          getter for the node
 VirtualNode getVirtualNode()
          getter for the virtual node
 boolean isLocalizedOnAVirtualNode()
          gives deployment information
 void setNode(Node node)
          setter (one can only change the node BEFORE instantiating the component)
 void setVirtualNode(VirtualNode virtualNode)
          setter (one can only change the virtual node BEFORE instantiating the component)
 boolean uniqueInstance()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContentDescription

public ContentDescription(java.lang.String className,
                          java.lang.Object[] constructorParameters,
                          VirtualNode virtualNode,
                          Active activity,
                          MetaObjectFactory factory)
constructor

Parameters:
className - the name of the base class of the component If the component is a composite component, this class is by default Composite If the component is a parallel component, this class is by default ParallelComposite
constructorParameters - parameters of the constructor of the base class
virtualNode - virtual node where this component will be instantiated
activity - the activity as defined in the ProActive model
factory - overriden meta-object factory for the component. Can be null.

ContentDescription

public ContentDescription(java.lang.String className,
                          java.lang.Object[] constructorParameters,
                          Node node,
                          Active activity,
                          MetaObjectFactory factory)
constructor

Parameters:
className - the name of the base class of the component If the component is a composite component, this class is by default Composite If the component is a parallel component, this class is by default ParallelComposite
constructorParameters - parameters of the constructor of the base class
node - node where this component will be instantiated
activity - the activity as defined in the ProActive model
factory - overriden meta-object factory for the component. Can be null.

ContentDescription

public ContentDescription(java.lang.String className,
                          java.lang.Object[] constructorParameters)
constructor

Parameters:
className - the name of the base class of the component If the component is a composite component, this class is by default Composite If the component is a parallel component, this class is by default ParallelComposite
constructorParameters - parameters of the constructor of the base class

ContentDescription

public ContentDescription(java.lang.String className,
                          java.lang.Object[] constructorParameters,
                          VirtualNode virtualNode)
constructor

Parameters:
className - the name of the base class of the component If the component is a composite component, this class is by default Composite If the component is a parallel component, this class is by default ParallelComposite
constructorParameters - parameters of the constructor of the base class
virtualNode - virtual node where this component will be instantiated

ContentDescription

public ContentDescription(java.lang.String className,
                          java.lang.Object[] constructorParameters,
                          Node node)
constructor

Parameters:
className - the name of the base class of the component If the component is a composite component, this class is by default Composite If the component is a parallel component, this class is by default ParallelComposite
constructorParameters - parameters of the constructor of the base class
node - node where this component will be instantiated

ContentDescription

public ContentDescription(java.lang.String className)
constructor. As no node nor virtual node is specified, the component will be instantiated in the current virtual machine

Parameters:
className - the name of the base class of the component If the component is a composite component, this class is by default Composite If the component is a parallel component, this class is by default ParallelComposite
Method Detail

getActivity

public Active getActivity()
getter for the activity

Returns:
the activity of the active object

getClassName

public java.lang.String getClassName()
getter for the classname

Returns:
the name of the class

getConstructorParameters

public java.lang.Object[] getConstructorParameters()
getter for the constructor parameters

Returns:
constructor parameters

getFactory

public MetaObjectFactory getFactory()
getter for the metaobjects factory

Returns:
metaobjects factory

isLocalizedOnAVirtualNode

public boolean isLocalizedOnAVirtualNode()
gives deployment information

Returns:
true if the component is to be deployed on a virtual node

getNode

public Node getNode()
getter for the node

Returns:
the node where the component is to be deployed

getVirtualNode

public VirtualNode getVirtualNode()
getter for the virtual node

Returns:
the virtual node where the component is to be deployed

setVirtualNode

public void setVirtualNode(VirtualNode virtualNode)
setter (one can only change the virtual node BEFORE instantiating the component)

Parameters:
virtualNode - the new virtual node

setNode

public void setNode(Node node)
setter (one can only change the node BEFORE instantiating the component)

Parameters:
node - the new node

forceSingleInstance

public void forceSingleInstance()

uniqueInstance

public boolean uniqueInstance()


Copyright ? April 2005 INRIA All Rights Reserved.