com.plumtree.openfoundation.util
Interface IXPPropertyBag

All Known Implementing Classes:
XPPropertyBag

public interface IXPPropertyBag

Defines the requirements for XPPropertyBag and its sub classes.

Author:
unattributed

Method Summary
 IXPPropertyBag Clone()
          Clone.
 boolean Compare(IXPPropertyBag pBag)
          Compare propertybags to see if they contains the same information.
 int GetCount()
          Returns the count of elements in the property bag.
 IXPEnumerator GetEnumerator()
          Returns Enumerator for XPPropertyBag.
 void LoadFromBinary(byte[] vsaXML)
          LoadFromBinary.
 void LoadFromFile(java.lang.String FileName)
          LoadFromFile.
 void LoadFromXML(java.lang.String xmlString)
          LoadFromXML.
 double ReadAsDouble(java.lang.String property)
          Retrieve an individual property value by name.
 int ReadAsInt(java.lang.String property)
          Retrieve an individual property value by name.
 IXPPropertyBag ReadAsIXPPropertyBag(java.lang.String property)
          Retrieve an individual property value by name.
 java.lang.Object ReadAsObject(java.lang.String property)
          Retrieve an individual property value by name.
 java.lang.Object[] ReadAsObject1DArray(java.lang.String property)
          Retrieve an individual property value by name.
 java.lang.Object[][] ReadAsObject2DArray(java.lang.String property)
          Retrieve an individual property value by name.
 java.lang.String ReadAsString(java.lang.String property)
          Retrieve an individual property value by name.
 XPDateTime ReadAsXPDateTime(java.lang.String property)
          Retrieve an individual property value by name.
 void Remove(java.lang.String property)
          Remove.
 void RemoveAll()
          Removes All Elements.
 byte[] SaveToBinary(int nXMLFormat)
          SaveToBinary.
 void SaveToFile(java.lang.String FileName)
          SaveToFile.
 java.lang.String SaveToXML(int nXMLFormat)
          SaveToXML.
 void Write(java.lang.String property, double vValue)
          Set/add an individual property value by name.
 void Write(java.lang.String property, int vValue)
          Set/add an individual property value by name.
 void Write(java.lang.String property, IXPPropertyBag vValue)
          Set/add an individual property value by name.
 void Write(java.lang.String property, java.lang.Object vValue)
          Write.
 void Write(java.lang.String property, java.lang.Object[] vValue)
          Write.
 void Write(java.lang.String property, java.lang.Object[][] vValue)
          Write.
 void Write(java.lang.String property, java.lang.String vValue)
          Set/add an individual property value by name.
 void Write(java.lang.String property, XPDateTime vValue)
          Set/add an individual property value by name.
 

Method Detail

GetCount

public int GetCount()
Returns the count of elements in the property bag.

Returns:
a int value indicating the count of elements in the property bag.

ReadAsInt

public int ReadAsInt(java.lang.String property)
Retrieve an individual property value by name.

Parameters:
property - Property Value to be read as int.
Returns:
a int value.

ReadAsString

public java.lang.String ReadAsString(java.lang.String property)
Retrieve an individual property value by name.

Parameters:
property - Property Value to be read as String.
Returns:
Retrieve an individual property String.

ReadAsXPDateTime

public XPDateTime ReadAsXPDateTime(java.lang.String property)
Retrieve an individual property value by name.

Parameters:
property - XPDateTime Value to be read as String.
Returns:
XPDateTime.

ReadAsDouble

public double ReadAsDouble(java.lang.String property)
Retrieve an individual property value by name.

Parameters:
property - Property Value to be read as String.
Returns:
double value

ReadAsIXPPropertyBag

public IXPPropertyBag ReadAsIXPPropertyBag(java.lang.String property)
Retrieve an individual property value by name.

Parameters:
property - Property Value to be read as String.
Returns:
IXPPropertyBag implementations.

ReadAsObject1DArray

public java.lang.Object[] ReadAsObject1DArray(java.lang.String property)
Retrieve an individual property value by name.

Parameters:
property - Property Value to be read as String.
Returns:
Object Array.

ReadAsObject2DArray

public java.lang.Object[][] ReadAsObject2DArray(java.lang.String property)
Retrieve an individual property value by name.

Parameters:
property - Property Value to be read as String.
Returns:
Object 2D Array.

ReadAsObject

public java.lang.Object ReadAsObject(java.lang.String property)
Retrieve an individual property value by name.

Parameters:
property - Property Value to be read as String.
Returns:
Object.

Write

public void Write(java.lang.String property,
                  int vValue)
Set/add an individual property value by name.

Parameters:
property - Property name as String.
vValue - Property Value as int

Write

public void Write(java.lang.String property,
                  java.lang.String vValue)
Set/add an individual property value by name.

Parameters:
property - Property name as String.
vValue - Property Value as String.

Write

public void Write(java.lang.String property,
                  XPDateTime vValue)
Set/add an individual property value by name.

Parameters:
property - Property name as String.
vValue - Property Value as XPDateTime.

Write

public void Write(java.lang.String property,
                  double vValue)
Set/add an individual property value by name.

Parameters:
property - Property name as String.
vValue - Property Value as double.

Write

public void Write(java.lang.String property,
                  IXPPropertyBag vValue)
Set/add an individual property value by name.

Parameters:
property - Property name as String.
vValue - Property Value as IXPPropertyBag.

Write

public void Write(java.lang.String property,
                  java.lang.Object[] vValue)
Write. Set/add an individual property value by name.

Parameters:
property - Property name as String.
vValue - Property Value as Object Array.

Write

public void Write(java.lang.String property,
                  java.lang.Object[][] vValue)
Write. Set/add an individual property value by name.

Parameters:
property - Property name as String.
vValue - Property Value as 2D Object Array.

Write

public void Write(java.lang.String property,
                  java.lang.Object vValue)
Write. Set/add an individual property value by name.

Parameters:
property - Property name as String.
vValue - Property Value as Object.

GetEnumerator

public IXPEnumerator GetEnumerator()
Returns Enumerator for XPPropertyBag.

Returns:
Enumerator for XPPropertyBag.

Remove

public void Remove(java.lang.String property)
Remove. Remove an individual property value by name.

Parameters:
property - to be removed.

RemoveAll

public void RemoveAll()
Removes All Elements.


LoadFromXML

public void LoadFromXML(java.lang.String xmlString)
LoadFromXML. Initializes the property bag from a string-ized XML format.

Parameters:
xmlString - XML in String Format as input.

SaveToXML

public java.lang.String SaveToXML(int nXMLFormat)
SaveToXML. Writes a property bag from a string-ized XML format.

Parameters:
nXMLFormat - Stringized XMl Format.
Returns:
String XML

Clone

public IXPPropertyBag Clone()
Clone. Create a copy of this propertybag.

Returns:
Property Bag

LoadFromFile

public void LoadFromFile(java.lang.String FileName)
LoadFromFile. Load this PropertyBag from a text file.

Parameters:
FileName - to Load From.

SaveToFile

public void SaveToFile(java.lang.String FileName)
SaveToFile. Save this PropertyBag to a text file.

Parameters:
FileName - to Save to.

Compare

public boolean Compare(IXPPropertyBag pBag)
Compare propertybags to see if they contains the same information.

Parameters:
pBag - The XPPropertyBag to Compare.
Returns:
boolean value.

LoadFromBinary

public void LoadFromBinary(byte[] vsaXML)
LoadFromBinary. Initializes the property bag from a binary XML format.

Parameters:
vsaXML - Input Binary to load XML from.

SaveToBinary

public byte[] SaveToBinary(int nXMLFormat)
SaveToBinary. Writes a property bag from a binary XML format.

Parameters:
nXMLFormat - Input to be saved to Binary.
Returns:
An array of Bytes.


Copyright 2002, 2003, 2004 Plumtree Software Inc. All Rights Reserved.