org.liquidsite.core.data
Class AbstractData

java.lang.Object
  extended byorg.liquidsite.core.data.AbstractData
Direct Known Subclasses:
AttributeData, ConfigurationData, ContentData, DomainData, GroupData, HostData, LockData, PermissionData, PreferenceData, UserData, UserGroupData

public abstract class AbstractData
extends java.lang.Object

An abstract data object. This is the base class for all the data objects in this package. It contains methods for handling the data parameters.


Nested Class Summary
protected static class AbstractData.BooleanParameter
          A boolean data object parameter.
protected static class AbstractData.DateParameter
          A date data object parameter.
protected static class AbstractData.IntegerParameter
          An integer data object parameter.
protected static class AbstractData.Parameter
          A data object parameter.
protected static class AbstractData.StringParameter
          A string data object parameter.
 
Constructor Summary
protected AbstractData()
          Creates a new data object.
 
Method Summary
 boolean getBoolean(AbstractData.Parameter param)
          Returns a parameter boolean value.
 java.util.Date getDate(AbstractData.Parameter param)
          Returns a parameter date value.
 int getInt(AbstractData.Parameter param)
          Returns a parameter integer value.
protected static org.liquidsite.core.data.AbstractData.ParameterSet getParameterSet(java.lang.Class dataClass)
          Returns the parameter set for a specified data class.
 java.lang.String getString(AbstractData.Parameter param)
          Returns a parameter string value.
 void setBoolean(AbstractData.Parameter param, boolean value)
          Sets a parameter boolean value.
 void setDate(AbstractData.Parameter param, java.util.Date value)
          Sets a parameter date value.
 void setInt(AbstractData.Parameter param, int value)
          Sets a parameter integer value.
 void setString(AbstractData.Parameter param, java.lang.String value)
          Sets a parameter string value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractData

protected AbstractData()
Creates a new data object. This will initialize all parameters to their default values.

Method Detail

getParameterSet

protected static org.liquidsite.core.data.AbstractData.ParameterSet getParameterSet(java.lang.Class dataClass)
Returns the parameter set for a specified data class. If no parameter set existed for the specified class, a new one will be created.

Parameters:
dataClass - the data class
Returns:
the parameter set for the specified data class

getBoolean

public boolean getBoolean(AbstractData.Parameter param)
Returns a parameter boolean value.

Parameters:
param - the parameter name
Returns:
the parameter boolean value, or false if the parameter doesn't exist

getDate

public java.util.Date getDate(AbstractData.Parameter param)
Returns a parameter date value.

Parameters:
param - the parameter name
Returns:
the parameter date value, or a zero date if the parameter doesn't exist

getInt

public int getInt(AbstractData.Parameter param)
Returns a parameter integer value.

Parameters:
param - the parameter name
Returns:
the parameter integer value, or zero (0) if the parameter doesn't exist

getString

public java.lang.String getString(AbstractData.Parameter param)
Returns a parameter string value.

Parameters:
param - the parameter name
Returns:
the parameter string value, or an empty string if the parameter doesn't exist

setBoolean

public void setBoolean(AbstractData.Parameter param,
                       boolean value)
Sets a parameter boolean value.

Parameters:
param - the parameter name
value - the parameter value

setDate

public void setDate(AbstractData.Parameter param,
                    java.util.Date value)
Sets a parameter date value.

Parameters:
param - the parameter name
value - the parameter value

setInt

public void setInt(AbstractData.Parameter param,
                   int value)
Sets a parameter integer value.

Parameters:
param - the parameter name
value - the parameter value

setString

public void setString(AbstractData.Parameter param,
                      java.lang.String value)
Sets a parameter string value.

Parameters:
param - the parameter name
value - the parameter value