lio.core
Class LiOResourceDefinition

java.lang.Object
  extended by lio.core.LiOResourceDefinition

public class LiOResourceDefinition
extends java.lang.Object

Contains the description of a resource including is concrete instantiation and values for its parameters.


Constructor Summary
LiOResourceDefinition(java.lang.String pResourceName)
          Creates a new instance of resDescription given the kind of resource.
LiOResourceDefinition(java.lang.String pResourceName, java.lang.String pInstantiation)
          Creates a new instance of resDescription given both the kind of resource and instantiation.
LiOResourceDefinition(java.lang.String pResourceName, java.lang.String pInstantiation, java.lang.String pDescription)
          Creates a new instance of resDescription given both the kind of resource and instantiation.
LiOResourceDefinition(java.lang.String pResourceName, java.lang.String pInstantiation, java.lang.String pKindOfIndividual, java.lang.String pDescription)
          Creates a new instance of resDescription given both the kind of resource and instantiation.
 
Method Summary
 void addMember(java.lang.String pVarName, java.lang.String pTextTip)
          Add a new member.
 java.lang.String getDescription()
          Gets the resource's description
 java.lang.String getInstantiationName()
          Gets the specific instantiation
 java.lang.String getKindOfIndividuals()
           
 LiOMember getMember(java.lang.String memberName)
          Return the member that match with the give name.
 LiOMember[] getMembers()
          Returns an array containing the members and its corresponding values
 java.lang.String getResourceName()
          Returns the generic resource name.
 void setDescription(java.lang.String pDescription)
          Sets resource description
 void setInstantiationName(java.lang.String pInstantiationName)
           
 void setKindOfIndividuals(java.lang.String kindOfIndividuals)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LiOResourceDefinition

public LiOResourceDefinition(java.lang.String pResourceName)
Creates a new instance of resDescription given the kind of resource. That is, an interface name.

Parameters:
pResourceName - kind of resource

LiOResourceDefinition

public LiOResourceDefinition(java.lang.String pResourceName,
                             java.lang.String pInstantiation)
Creates a new instance of resDescription given both the kind of resource and instantiation. (Generic interface and its implementation)

Parameters:
pResourceName - name of the abstract class defining the resource.
pInstantiation - name of the class which implements the resource.

LiOResourceDefinition

public LiOResourceDefinition(java.lang.String pResourceName,
                             java.lang.String pInstantiation,
                             java.lang.String pDescription)
Creates a new instance of resDescription given both the kind of resource and instantiation. (Generic interface and its implementation)

Parameters:
pResourceName - name of the abstract class defining the resource.
pInstantiation - name of the class which implements the resource.
pDescription - short description of the resource about its functionality

LiOResourceDefinition

public LiOResourceDefinition(java.lang.String pResourceName,
                             java.lang.String pInstantiation,
                             java.lang.String pKindOfIndividual,
                             java.lang.String pDescription)
Creates a new instance of resDescription given both the kind of resource and instantiation. (Generic interface and its implementation)

Parameters:
pResourceName - name of the abstract class defining the resource.
pInstantiation - name of the class which implements the resource.
pKindOfIndividual - name of the class which implements the resource. *
pDescription - short description of the resource about its functionality
Method Detail

getResourceName

public java.lang.String getResourceName()
Returns the generic resource name.

Returns:
name of the interface which implements the resource.

getInstantiationName

public java.lang.String getInstantiationName()
Gets the specific instantiation

Returns:
name of the instantiation.

setInstantiationName

public void setInstantiationName(java.lang.String pInstantiationName)

getDescription

public java.lang.String getDescription()
Gets the resource's description

Returns:
resource's description

setDescription

public void setDescription(java.lang.String pDescription)
Sets resource description

Parameters:
pDescription - short description of the resource about its functionality

addMember

public void addMember(java.lang.String pVarName,
                      java.lang.String pTextTip)
Add a new member.

Parameters:
pVarName - member name.
pTextTip - member description.

getMembers

public LiOMember[] getMembers()
Returns an array containing the members and its corresponding values

Returns:
an array with the members and their values.

getMember

public LiOMember getMember(java.lang.String memberName)
Return the member that match with the give name.

Parameters:
memberName - name of the member.
Returns:
a LiOMember object.

getKindOfIndividuals

public java.lang.String getKindOfIndividuals()
Returns:
the kindOfIndividuals

setKindOfIndividuals

public void setKindOfIndividuals(java.lang.String kindOfIndividuals)
Parameters:
kindOfIndividuals - the kindOfIndividuals to set