org.stanwood.media.setup
Class BaseMediaDirSubItem

java.lang.Object
  extended by org.stanwood.media.setup.BaseMediaDirSubItem
Direct Known Subclasses:
ActionConfig, SourceConfig, StoreConfig

public class BaseMediaDirSubItem
extends java.lang.Object

This is a base class for all sub items of the media directory configuration.


Constructor Summary
BaseMediaDirSubItem()
           
 
Method Summary
 void addParam(java.lang.String key, java.lang.String value)
          Used to add a parameter of the store/store/action to it's configuration.
 java.lang.String getID()
          Used to get the ID of the store/store/action.
 int getNumber()
          Used to get the index number of the store within the configuration
 java.util.Map<java.lang.String,java.lang.String> getParams()
          Used to get the key/value pair parameters of the store/store/action.
 void setID(java.lang.String id)
          Used to set the ID of the store/store/action.
 void setNumber(int num)
          Used set the index number of the store within the configuration
 void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
          Used to set the parameters
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BaseMediaDirSubItem

public BaseMediaDirSubItem()
Method Detail

getID

public java.lang.String getID()
Used to get the ID of the store/store/action. The ID is the full class name of the store/store/action and will be used to create the store/store/action.

Returns:
The ID of the store/store/action.

setID

public void setID(java.lang.String id)
Used to set the ID of the store/store/action. The ID is the full class name of the store/store/action and will be used to create the store/store/action.

Parameters:
id - The ID of the store.

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()
Used to get the key/value pair parameters of the store/store/action.

Returns:
A hash map containing store parameters.

addParam

public void addParam(java.lang.String key,
                     java.lang.String value)
Used to add a parameter of the store/store/action to it's configuration.

Parameters:
key - The key of the parameter
value - The value of the parameter

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Used to set the parameters

Parameters:
parameters - The parameters

setNumber

public void setNumber(int num)
Used set the index number of the store within the configuration

Parameters:
num - the index number of the store within the configuration

getNumber

public int getNumber()
Used to get the index number of the store within the configuration

Returns:
the index number of the store within the configuration