|
|||||||||
| Home >> All >> recoin >> [ group overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
recoin.group
Interface Component
- All Known Implementing Classes:
- ComponentImpl, ComponentView
- public interface Component
A Component represents an object that takes part in and contributes to the information
retrieval process. This can be, for example, a component that handles the connection to
a database or IR system or a component that carries out result merging.
The Component interface describes the basic functionality of a Component that is used
in the RECOIN framework. It specifies methods to access and manipulate a Component's
attributes and methods which are used when the Component is loaded in the framework.
- Version:
- 0.2.9
| Method Summary | |
ComponentRunnable |
createComponentRunnable(recoin.container.RetrievalContainer container)
Creates a new ComponentRunnable using the specified RetrievalContainer. |
ComponentRunnable |
createComponentRunnable(recoin.container.RetrievalContainer container,
recoin.system.session.ComponentOrder order)
Creates a new ComponentRunnable using the specified RetrievalContainer and ComponentOrder. |
ComponentRunnable |
createComponentRunnable(recoin.container.RetrievalContainer container,
recoin.system.session.ComponentOrder order,
ComponentRunnable runnable)
Creates a new ComponentRunnable using the specified RetrievalContainer, ComponentOrder and ComponentRunnable to establish a chain of execution. |
ComponentRunnable |
createComponentRunnable(recoin.container.RetrievalContainer container,
ComponentSupport support)
Creates a new ComponentRunnable using the specified RetrievalContainer and ComponentSupport. |
boolean |
equals(java.lang.Object o)
Compares the Component to the specified Object. |
java.lang.String |
generateChainID()
Generates a String ID that identifies this Component and the relation to the Module it is contained in. |
java.lang.String[] |
getAttributeNames()
Returns the names of the attributes of the Component in a String array. |
java.util.Hashtable |
getAttributes()
Returns the attributes of the Component in a Hashtable where the attribute names are the keys and the attribute values the values of the hash. |
java.lang.String |
getClassname()
Returns the classname of the Component. |
java.lang.String |
getDescription()
Returns a description of the Component. |
java.lang.String |
getGroupname()
Returns the name of the ModuleGroup the Component belongs to if it is contained in a Module and the Module is deployed. |
int |
getID()
Returns the unique ID of the Component. |
java.util.Vector |
getInOutSupport()
Returns the InOutSupport objects of the Component. |
Module |
getModule()
Returns the Module in which the Component is contained. |
ModuleGroup |
getModuleGroup()
Returns the ModuleGroup the Component belongs to if it is contained in a Module and the Module is deployed. |
java.lang.String |
getName()
Returns the name of the Component. |
java.lang.String[] |
getRuntimeParameterNames()
Returns the names of the runtime parameters in a String array. |
java.util.Hashtable |
getRuntimeParameters()
Returns the runtime parameters of the Component in a Hashtable where the parameter names are the keys and the parameter values the values of the hash. |
boolean |
hasSupportFor(ComponentSupport support)
Checks whether the Component has declared to be able to process the specified ComponentSupport. |
void |
initiate()
Initiates the Component. |
boolean |
isInitiated()
Returns whether the Component has been initiated or not. |
ComponentSupport |
markComponentSupport(ComponentSupport support)
Appends this Component's chain ID to the chain ID of the ComponentSupport. |
void |
setAttributes(java.util.Hashtable attributes)
Sets the attributes of the Component to be the specified ones. |
void |
setClassname(java.lang.String classname)
Sets the classname of the Component to the specified one. |
void |
setDescription(java.lang.String description)
Sets the description of the Component to the specified one. |
void |
setInitiated(boolean initiated)
Sets the 'initiated' state of the Component to the specified value. |
void |
setModule(Module module)
Sets the Module of the Component to be the specified one. |
void |
setName(java.lang.String name)
Sets the name of the Component to the specified name. |
void |
setRuntimeParameters(java.util.Hashtable parameters)
Sets the runtime parameters of the Component to the specified ones. |
| Method Detail |
isInitiated
public boolean isInitiated()
- Returns whether the Component has been initiated or not.
getID
public int getID()
- Returns the unique ID of the Component.
getClassname
public java.lang.String getClassname()
- Returns the classname of the Component.
getAttributes
public java.util.Hashtable getAttributes()
- Returns the attributes of the Component in a Hashtable where the attribute names
are the keys and the attribute values the values of the hash.
getAttributeNames
public java.lang.String[] getAttributeNames()
- Returns the names of the attributes of the Component in a String array.
getRuntimeParameters
public java.util.Hashtable getRuntimeParameters()
- Returns the runtime parameters of the Component in a Hashtable where the parameter
names are the keys and the parameter values the values of the hash.
getRuntimeParameterNames
public java.lang.String[] getRuntimeParameterNames()
- Returns the names of the runtime parameters in a String array.
getDescription
public java.lang.String getDescription()
- Returns a description of the Component.
getName
public java.lang.String getName()
- Returns the name of the Component.
getGroupname
public java.lang.String getGroupname()
- Returns the name of the ModuleGroup the Component belongs to if it is contained in a
Module and the Module is deployed.
getModule
public Module getModule()
- Returns the Module in which the Component is contained.
getModuleGroup
public ModuleGroup getModuleGroup()
- Returns the ModuleGroup the Component belongs to if it is contained in a Module and
the Module is deployed.
getInOutSupport
public java.util.Vector getInOutSupport()
- Returns the InOutSupport objects of the Component.
hasSupportFor
public boolean hasSupportFor(ComponentSupport support)
- Checks whether the Component has declared to be able to process the specified
ComponentSupport.
createComponentRunnable
public ComponentRunnable createComponentRunnable(recoin.container.RetrievalContainer container) throws recoin.exception.ComponentException
- Creates a new ComponentRunnable using the specified RetrievalContainer.
createComponentRunnable
public ComponentRunnable createComponentRunnable(recoin.container.RetrievalContainer container, ComponentSupport support) throws recoin.exception.ComponentException
- Creates a new ComponentRunnable using the specified RetrievalContainer
and ComponentSupport.
createComponentRunnable
public ComponentRunnable createComponentRunnable(recoin.container.RetrievalContainer container, recoin.system.session.ComponentOrder order) throws recoin.exception.ComponentException
- Creates a new ComponentRunnable using the specified RetrievalContainer and
ComponentOrder.
createComponentRunnable
public ComponentRunnable createComponentRunnable(recoin.container.RetrievalContainer container, recoin.system.session.ComponentOrder order, ComponentRunnable runnable) throws recoin.exception.ComponentException
- Creates a new ComponentRunnable using the specified RetrievalContainer, ComponentOrder
and ComponentRunnable to establish a chain of execution.
setInitiated
public void setInitiated(boolean initiated)
- Sets the 'initiated' state of the Component to the specified value.
setAttributes
public void setAttributes(java.util.Hashtable attributes)
- Sets the attributes of the Component to be the specified ones.
setRuntimeParameters
public void setRuntimeParameters(java.util.Hashtable parameters)
- Sets the runtime parameters of the Component to the specified ones.
setClassname
public void setClassname(java.lang.String classname)
- Sets the classname of the Component to the specified one.
setDescription
public void setDescription(java.lang.String description)
- Sets the description of the Component to the specified one.
setName
public void setName(java.lang.String name)
- Sets the name of the Component to the specified name.
setModule
public void setModule(Module module)
- Sets the Module of the Component to be the specified one.
initiate
public void initiate()
throws recoin.exception.InitiationException
- Initiates the Component. Any setup measures that have to be carried out before the
Component can start working should be placed in this method.
equals
public boolean equals(java.lang.Object o)
- Compares the Component to the specified Object.
generateChainID
public java.lang.String generateChainID()
- Generates a String ID that identifies this Component and the relation to the Module
it is contained in.
markComponentSupport
public ComponentSupport markComponentSupport(ComponentSupport support)
- Appends this Component's chain ID to the chain ID of the ComponentSupport.
|
|||||||||
| Home >> All >> recoin >> [ group overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||