com.filenet.wcm.toolkit.server.util.prefs
Class WcmPrefsObject

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
AllControllerPrefs, ControllerPrefs, HomePagePrefs, PolicyProcessorPrefs

public class WcmPrefsObject
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Base preferences object class

See Also:
Serialized Form

Constructor Summary
WcmPrefsObject()
           
 
Method Summary
 void clear()
          Clears the data
 void clearAttributes()
          CLears the temporary attributes map
 java.lang.Object clone()
           
protected static boolean convertToBoolean(java.lang.Object value)
           
protected static boolean convertToBoolean(java.lang.Object value, boolean defaultValue)
           
protected static int convertToInt(java.lang.Object value)
           
protected static long convertToLong(java.lang.Object value)
           
protected static PrefsLabel convertToPrefsLabel(java.lang.Object value)
           
protected static PrefsLabel[] convertToPrefsLabelArray(java.lang.Object value)
           
 boolean equals(java.lang.Object o)
           
 java.lang.Object get(java.lang.String key)
          Returns the value mapped to the key
 java.lang.Object getAttribute(java.lang.Object key)
          Returns temporary attribute mapped to the key
 boolean getBoolean(java.lang.String key)
          Returns the setting as a boolean
 java.lang.String getElementKey()
          Returns the value of key attribute of this object
 int getInt(java.lang.String key)
          Returns the value of a setting as Int
 PrefsLabel getLabel(java.lang.String key)
           
 PrefsLabel[] getLabelArray(java.lang.String key)
          Returns the value of a setting as PrefsLabel[]
 java.util.List getList(java.lang.String key)
          Returns the value of a setting as List
 WcmString getLocalizedString(java.lang.String key)
          Returns WcmString value mapped to the key
 java.lang.String getString(java.lang.String key)
          Returns the setting as a String
 java.lang.String[] getStringArray(java.lang.String key)
          Returns the value of a setting as String[]
 java.lang.String getVersion()
          Returns the version number of the preference object
protected  void initialize()
          In sub-classes, read the values from internal map using get methods into member variables.
 void load(org.w3c.dom.Document doc)
          Loads the object from DOM Document
 void load(org.w3c.dom.Element element)
          Loads the object from DOM Element
 void load(java.io.InputStream in)
          Loads the object from an InputStream
 void load(java.lang.String xml)
          Loads the object from a String
static PrefsLabel loadLabel(org.w3c.dom.Element e)
           
static WcmPrefsObject loadPreferences(org.w3c.dom.Document doc)
           
static WcmPrefsObject loadPreferences(java.io.InputStream in)
           
static WcmPrefsObject loadPreferences(java.lang.String xml)
           
protected  void persist()
          In sub-classes, write the values from member variables into the internal map using put method.
 void put(java.lang.String key, boolean value)
          Sets a value as boolean
 void put(java.lang.String key, int value)
          Sets a value as int
 void put(java.lang.String key, java.util.List value)
          Sets a value as List
 void put(java.lang.String key, PrefsLabel value)
           
 void put(java.lang.String key, PrefsLabel[] value)
           
 void put(java.lang.String key, java.lang.String value)
          Sets a value as a String
 void put(java.lang.String key, java.lang.String[] value)
          Sets a value as String array
 void put(java.lang.String key, WcmPrefsObject value)
          Sets a value as WcmPrefsObject
static void registerKey(java.lang.String sObjectKey, java.lang.Class c)
           
 java.lang.Object remove(java.lang.String key)
          Removes the value mapped to the key
 void removeAttribute(java.lang.Object key)
          Removes temporary attribute
 WcmString removeLocalizedString(java.lang.String key)
          Removes the localized mapped to the key
protected  void saveToXML(java.io.Writer w)
          Overwrite this method if you want to hanlde saving data yourself.
 void setAttribute(java.lang.Object key, java.lang.Object value)
          Sets temporary attribute
 void setElementKey(java.lang.String name)
          Sets the value of the key attribute that is saved to xml
 void setVersion(java.lang.String version)
          Sets the version number of the preference object
 byte[] toByteArrayXML()
          Returns XML representation of this object in byte array form This method uses UTF-8 encoding
 java.lang.String toXML()
          Returns XML representation of this object
protected  void writeEndSettingTag(java.io.Writer w)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, boolean value)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, boolean[] values)
          write a boolean array
protected  void writeSetting(java.io.Writer w, java.lang.String key, int value)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, java.util.List values)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, long value)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, PrefsLabel value)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, PrefsLabel[] values)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, java.lang.String value)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, java.lang.String[] values)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, WcmPrefsObject value)
           
protected  void writeSetting(java.io.Writer w, java.lang.String key, WcmString value)
           
protected  void writeStartSettingTag(java.io.Writer w, java.lang.String sKey)
           
protected  void writeStartSettingTag(java.io.Writer w, java.lang.String key, java.lang.String localizationKey)
           
 void writeXML(java.io.Writer w)
          Writes XML representation of this object to a Writer
 void writeXML(java.io.Writer w, java.lang.String encoding)
          Writes the XML representation of this object to a Writer.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WcmPrefsObject

public WcmPrefsObject()
Method Detail

clear

public void clear()
Clears the data


getVersion

public java.lang.String getVersion()
Returns the version number of the preference object

Returns:
String

setVersion

public void setVersion(java.lang.String version)
Sets the version number of the preference object

Parameters:
version -

getElementKey

public final java.lang.String getElementKey()
Returns the value of key attribute of this object

Returns:
String

setElementKey

public final void setElementKey(java.lang.String name)
Sets the value of the key attribute that is saved to xml

Parameters:
name -

setAttribute

public void setAttribute(java.lang.Object key,
                         java.lang.Object value)
Sets temporary attribute

Parameters:
key -
value -

getAttribute

public java.lang.Object getAttribute(java.lang.Object key)
Returns temporary attribute mapped to the key

Parameters:
key -
Returns:
Object

removeAttribute

public void removeAttribute(java.lang.Object key)
Removes temporary attribute

Parameters:
key -

clearAttributes

public void clearAttributes()
CLears the temporary attributes map


put

public void put(java.lang.String key,
                boolean value)
Sets a value as boolean

Parameters:
key -
value -

put

public void put(java.lang.String key,
                int value)
Sets a value as int

Parameters:
key -
value -

put

public void put(java.lang.String key,
                java.lang.String value)
Sets a value as a String

Parameters:
key -
value -

put

public void put(java.lang.String key,
                java.lang.String[] value)
Sets a value as String array

Parameters:
key -
value -

put

public void put(java.lang.String key,
                PrefsLabel value)

put

public void put(java.lang.String key,
                PrefsLabel[] value)

put

public void put(java.lang.String key,
                WcmPrefsObject value)
Sets a value as WcmPrefsObject

Parameters:
key -
value -

put

public void put(java.lang.String key,
                java.util.List value)
Sets a value as List

Parameters:
key -
value -

remove

public java.lang.Object remove(java.lang.String key)
Removes the value mapped to the key

Parameters:
key -
Returns:
Object

removeLocalizedString

public WcmString removeLocalizedString(java.lang.String key)
Removes the localized mapped to the key

Parameters:
key -
Returns:
Object

get

public java.lang.Object get(java.lang.String key)
Returns the value mapped to the key

Parameters:
key -
Returns:
Object

getLocalizedString

public WcmString getLocalizedString(java.lang.String key)
Returns WcmString value mapped to the key

Parameters:
key -
Returns:
WcmString

convertToBoolean

protected static boolean convertToBoolean(java.lang.Object value)

convertToBoolean

protected static boolean convertToBoolean(java.lang.Object value,
                                          boolean defaultValue)

getBoolean

public boolean getBoolean(java.lang.String key)
Returns the setting as a boolean

Parameters:
key -
Returns:
boolean

getLabel

public PrefsLabel getLabel(java.lang.String key)

getString

public java.lang.String getString(java.lang.String key)
Returns the setting as a String

Parameters:
key -
Returns:
String

convertToInt

protected static int convertToInt(java.lang.Object value)

convertToLong

protected static long convertToLong(java.lang.Object value)

convertToPrefsLabelArray

protected static PrefsLabel[] convertToPrefsLabelArray(java.lang.Object value)

convertToPrefsLabel

protected static PrefsLabel convertToPrefsLabel(java.lang.Object value)

getInt

public int getInt(java.lang.String key)
Returns the value of a setting as Int

Parameters:
key -
Returns:
int

getStringArray

public java.lang.String[] getStringArray(java.lang.String key)
Returns the value of a setting as String[]

Parameters:
key -
Returns:
String array

getList

public java.util.List getList(java.lang.String key)
Returns the value of a setting as List

Parameters:
key -
Returns:
List

getLabelArray

public PrefsLabel[] getLabelArray(java.lang.String key)
Returns the value of a setting as PrefsLabel[]

Parameters:
key -
Returns:
PrefsLabel array

toXML

public final java.lang.String toXML()
                             throws java.io.IOException
Returns XML representation of this object

Returns:
String
Throws:
java.io.IOException

toByteArrayXML

public final byte[] toByteArrayXML()
                            throws java.io.IOException
Returns XML representation of this object in byte array form This method uses UTF-8 encoding

Returns:
byte array
Throws:
java.io.IOException

writeXML

public final void writeXML(java.io.Writer w)
                    throws java.io.IOException
Writes XML representation of this object to a Writer

Parameters:
w -
Throws:
java.io.IOException

writeXML

public final void writeXML(java.io.Writer w,
                           java.lang.String encoding)
                    throws java.io.IOException
Writes the XML representation of this object to a Writer. If the encoding parameter is specified, it is written in a <?xml ... > tag prior to writing out of the remainder of the XML file.

Parameters:
w -
encoding -
Throws:
java.io.IOException

writeStartSettingTag

protected final void writeStartSettingTag(java.io.Writer w,
                                          java.lang.String key,
                                          java.lang.String localizationKey)
                                   throws java.io.IOException
Throws:
java.io.IOException

writeStartSettingTag

protected final void writeStartSettingTag(java.io.Writer w,
                                          java.lang.String sKey)
                                   throws java.io.IOException
Throws:
java.io.IOException

writeEndSettingTag

protected final void writeEndSettingTag(java.io.Writer w)
                                 throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  boolean value)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  boolean[] values)
                           throws java.io.IOException
write a boolean array

Parameters:
w - The Writer to write on
key - The key to the array
values - The boolean array to write.
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  PrefsLabel value)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  int value)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  long value)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  java.lang.String value)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  WcmString value)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  PrefsLabel[] values)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  java.lang.String[] values)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  java.util.List values)
                           throws java.io.IOException
Throws:
java.io.IOException

writeSetting

protected final void writeSetting(java.io.Writer w,
                                  java.lang.String key,
                                  WcmPrefsObject value)
                           throws java.io.IOException
Throws:
java.io.IOException

saveToXML

protected void saveToXML(java.io.Writer w)
                  throws java.io.IOException
Overwrite this method if you want to hanlde saving data yourself. Make sure to call clear() method after you are done, so the internal map is cleared, and values are not saved twice

Parameters:
w - Writer object
Throws:
java.io.IOException - if any IO errors occur when writing the xml

initialize

protected void initialize()
In sub-classes, read the values from internal map using get methods into member variables.


persist

protected void persist()
In sub-classes, write the values from member variables into the internal map using put method. Do this if you are not overwriting saveToXML method.


load

public void load(java.lang.String xml)
          throws java.lang.Exception
Loads the object from a String

Parameters:
xml -
Throws:
java.lang.Exception

load

public void load(java.io.InputStream in)
          throws java.lang.Exception
Loads the object from an InputStream

Parameters:
in -
Throws:
java.lang.Exception

load

public void load(org.w3c.dom.Document doc)
          throws java.lang.Exception
Loads the object from DOM Document

Parameters:
doc -
Throws:
java.lang.Exception

load

public void load(org.w3c.dom.Element element)
          throws java.lang.Exception
Loads the object from DOM Element

Parameters:
element -
Throws:
java.lang.Exception

registerKey

public static void registerKey(java.lang.String sObjectKey,
                               java.lang.Class c)

loadPreferences

public static WcmPrefsObject loadPreferences(java.lang.String xml)
                                      throws java.lang.Exception
Throws:
java.lang.Exception

loadPreferences

public static WcmPrefsObject loadPreferences(java.io.InputStream in)
                                      throws java.lang.Exception
Throws:
java.lang.Exception

loadPreferences

public static WcmPrefsObject loadPreferences(org.w3c.dom.Document doc)
                                      throws java.lang.Exception
Throws:
java.lang.Exception

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Throws:
java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object o)

loadLabel

public static PrefsLabel loadLabel(org.w3c.dom.Element e)


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.