Simias::Storage::PropertyList Class Reference

Represents the list of properties on an object. Properties maybe added, retrieved, enumerated, or deleted from this object. More...

List of all members.

Public Member Functions
void	AddNodeProperty (Property property)
	Adds a property to the existing property list.
void	AddNodeProperty (string name, string propertyValue)
	Adds a string type property to the existing property list.
void	AddProperty (Property property)
	Adds a property to the existing property list.
void	AddProperty (string name, object propertyValue)
	Adds an object type property to the existing property list.
void	AddProperty (string name, string propertyValue)
	Adds a string type property to the existing property list.
void	AddProperty (string name, sbyte propertyValue)
	Adds a sbyte type property to the existing property list.
void	AddProperty (string name, byte propertyValue)
	Adds a byte type property to the existing property list.
void	AddProperty (string name, short propertyValue)
	Adds a short type property to the existing property list.
void	AddProperty (string name, ushort propertyValue)
	Adds a ushort type property to the existing property list.
void	AddProperty (string name, int propertyValue)
	Adds an int type property to the existing property list.
void	AddProperty (string name, uint propertyValue)
	Adds a uint type property to the existing property list.
void	AddProperty (string name, long propertyValue)
	Adds a long type property to the existing property list.
void	AddProperty (string name, ulong propertyValue)
	Adds an ulong type property to the existing property list.
void	AddProperty (string name, char propertyValue)
	Adds a char type property to the existing property list.
void	AddProperty (string name, float propertyValue)
	Adds a float type property to the existing property list.
void	AddProperty (string name, bool propertyValue)
	Adds a bool type property to the existing property list.
void	AddProperty (string name, DateTime propertyValue)
	Adds a DateTime type property to the existing property list.
void	AddProperty (string name, Uri propertyValue)
	Adds a Uri type property to the existing property list.
void	AddProperty (string name, XmlDocument propertyValue)
	Adds an XmlDocument type property to the existing property list.
void	AddProperty (string name, TimeSpan propertyValue)
	Adds a TimeSpan type property to the existing property list.
void	AddProperty (string name, Relationship propertyValue)
	Adds a Relationship type property to the existing property list.
void	DeleteProperties (string name)
	Deletes the all occurances of the specified property from the property list.
void	DeleteSingleProperty (string name)
	Deletes the first occurance of the specified property from the property list.
void	DeleteSingleProperty (Property property)
	Deletes the first occurance of the specified property from the property list.
Property	GetSingleProperty (string name)
	Gets the first occurance of the specified property.
bool	HasProperty (string name)
	Checks for the existence of the specified property.
MultiValuedList	GetProperties (string name)
	Gets all occurances of the specified property name.
void	ModifyProperty (Property property)
	Modifies the first matching property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, object propertyValue)
	Modifies the first matching property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, string propertyValue)
	Modifies the first matching string property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, sbyte propertyValue)
	Modifies the first matching sbyte property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, byte propertyValue)
	Modifies the first matching byte property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, short propertyValue)
	Modifies the first matching short property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, ushort propertyValue)
	Modifies the first matching ushort property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, int propertyValue)
	Modifies the first matching int property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, uint propertyValue)
	Modifies the first matching uint property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, long propertyValue)
	Modifies the first matching long property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, ulong propertyValue)
	Modifies the first matching ulong property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, char propertyValue)
	Modifies the first matching char property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, float propertyValue)
	Modifies the first matching float property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, bool propertyValue)
	Modifies the first matching bool property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, DateTime propertyValue)
	Modifies the first matching DateTime property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, Uri propertyValue)
	Modifies the first matching Uri property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, XmlDocument propertyValue)
	Modifies the first matching XmlDocument property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, TimeSpan propertyValue)
	Modifies the first matching TimeSpan property in the list. If the property doesn't exist, it is created.
void	ModifyProperty (string name, Relationship propertyValue)
	Modifies the first matching Relationship property in the list. If the property doesn't exist, it is created.
override string	ToString ()
	Converts the PropertyList to a string representation.
string	ToString (bool stripLocalProperties)
	Converts the PropertyList to a string representation.
string	ToString (bool stripLocalProperties, bool LoggedInMember)
	Converts the PropertyList to a string representation, and strips local as well as client specific info.
IEnumerator	GetEnumerator ()
	Method used by clients to enumerate the properties in the list.
virtual void	GetObjectData (SerializationInfo info, StreamingContext context)
	Called by the ISerializable interface to serialize a Node object.
Protected Member Functions
	PropertyList (SerializationInfo info, StreamingContext context)
	Special constructor used to deserialize a PropertyList object.
Properties
XmlElement	PropertyRoot [get]
	Gets the parent element where the xml properties are stored.
int	Count [get]
	Gets the count of properties in the list not including the hidden properties.

---

Detailed Description

Represents the list of properties on an object. Properties maybe added, retrieved, enumerated, or deleted from this object.

---

Constructor & Destructor Documentation

Simias::Storage::PropertyList::PropertyList	(	SerializationInfo	info,
		StreamingContext	context
	)			[inline, protected]

Special constructor used to deserialize a PropertyList object.

Parameters:

	info	The SerializationInfo populated with the data.
	context	The source (see StreamingContext) for this serialization.

---

Member Function Documentation

void Simias::Storage::PropertyList::AddNodeProperty

(

Property

property

)

[inline]

Adds a property to the existing property list.

Parameters:

property

Property to add to the property list.

void Simias::Storage::PropertyList::AddNodeProperty	(	string	name,
		string	propertyValue
	)			[inline]

Adds a string type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	String value of the property to add.

void Simias::Storage::PropertyList::AddProperty

(

Property

property

)

[inline]

Adds a property to the existing property list.

Parameters:

property

Property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		object	propertyValue
	)			[inline]

Adds an object type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Object representation of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		string	propertyValue
	)			[inline]

Adds a string type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	String value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		sbyte	propertyValue
	)			[inline]

Adds a sbyte type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Signed 8-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		byte	propertyValue
	)			[inline]

Adds a byte type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Unsigned 8-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		short	propertyValue
	)			[inline]

Adds a short type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Signed 16-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		ushort	propertyValue
	)			[inline]

Adds a ushort type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Unsigned 16-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		int	propertyValue
	)			[inline]

Adds an int type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Signed 32-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		uint	propertyValue
	)			[inline]

Adds a uint type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Unsigned 32-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		long	propertyValue
	)			[inline]

Adds a long type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Signed 64-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		ulong	propertyValue
	)			[inline]

Adds an ulong type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Unsigned 64-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		char	propertyValue
	)			[inline]

Adds a char type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Unicode character value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		float	propertyValue
	)			[inline]

Adds a float type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Single precision 32-bit value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		bool	propertyValue
	)			[inline]

Adds a bool type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Boolean value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		DateTime	propertyValue
	)			[inline]

Adds a DateTime type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	DateTime value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		Uri	propertyValue
	)			[inline]

Adds a Uri type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Uri value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		XmlDocument	propertyValue
	)			[inline]

Adds an XmlDocument type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	XmlDocument value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		TimeSpan	propertyValue
	)			[inline]

Adds a TimeSpan type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	TimeSpan value of the property to add.

void Simias::Storage::PropertyList::AddProperty	(	string	name,
		Relationship	propertyValue
	)			[inline]

Adds a Relationship type property to the existing property list.

Parameters:

	name	Name of the property to add.
	propertyValue	Relationship value of the property to add.

void Simias::Storage::PropertyList::DeleteProperties

(

string

name

)

[inline]

Deletes the all occurances of the specified property from the property list.

Parameters:

name

Name of property to delete.

void Simias::Storage::PropertyList::DeleteSingleProperty

(

string

name

)

[inline]

Deletes the first occurance of the specified property from the property list.

Parameters:

name

Name of property to delete.

void Simias::Storage::PropertyList::DeleteSingleProperty

(

Property

property

)

[inline]

Deletes the first occurance of the specified property from the property list.

Parameters:

property

Property to delete from the list.

Property Simias::Storage::PropertyList::GetSingleProperty

(

string

name

)

[inline]

Gets the first occurance of the specified property.

Parameters:

name

Name of the property to retreive.

Returns:

A property object containing the value of the property if it exists. Otherwise a null is returned.

bool Simias::Storage::PropertyList::HasProperty

(

string

name

)

[inline]

Checks for the existence of the specified property.

Parameters:

name

Name of the property to check for existence.

Returns:

True if the property exists, otherwise false is returned.

MultiValuedList Simias::Storage::PropertyList::GetProperties

(

string

name

)

[inline]

Gets all occurances of the specified property name.

Parameters:

name

Name of the properties to retrieve.

Returns:

A MultiValuedList object that contains all of the values for the specified property.

void Simias::Storage::PropertyList::ModifyProperty

(

Property

property

)

[inline]

Modifies the first matching property in the list. If the property doesn't exist, it is created.

Parameters:

property

Property to modify.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		object	propertyValue
	)			[inline]

Modifies the first matching property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the property to modify.
	propertyValue	New property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		string	propertyValue
	)			[inline]

Modifies the first matching string property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the string property to modify.
	propertyValue	New string property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		sbyte	propertyValue
	)			[inline]

Modifies the first matching sbyte property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the sbyte property to modify.
	propertyValue	New sbyte property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		byte	propertyValue
	)			[inline]

Modifies the first matching byte property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the byte property to modify.
	propertyValue	New byte property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		short	propertyValue
	)			[inline]

Modifies the first matching short property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the short property to modify.
	propertyValue	New short property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		ushort	propertyValue
	)			[inline]

Modifies the first matching ushort property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the ushort property to modify.
	propertyValue	New ushort property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		int	propertyValue
	)			[inline]

Modifies the first matching int property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the int property to modify.
	propertyValue	New int property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		uint	propertyValue
	)			[inline]

Modifies the first matching uint property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the uint property to modify.
	propertyValue	New uint property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		long	propertyValue
	)			[inline]

Modifies the first matching long property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the long property to modify.
	propertyValue	New long property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		ulong	propertyValue
	)			[inline]

Modifies the first matching ulong property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the ulong property to modify.
	propertyValue	New ulong property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		char	propertyValue
	)			[inline]

Modifies the first matching char property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the char property to modify.
	propertyValue	New char property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		float	propertyValue
	)			[inline]

Modifies the first matching float property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the float property to modify.
	propertyValue	New float property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		bool	propertyValue
	)			[inline]

Modifies the first matching bool property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the bool property to modify.
	propertyValue	New bool property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		DateTime	propertyValue
	)			[inline]

Modifies the first matching DateTime property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the DateTime property to modify.
	propertyValue	New DateTime property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		Uri	propertyValue
	)			[inline]

Modifies the first matching Uri property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the Uri property to modify.
	propertyValue	New Uri property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		XmlDocument	propertyValue
	)			[inline]

Modifies the first matching XmlDocument property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the XmlDocument property to modify.
	propertyValue	New XmlDocument property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		TimeSpan	propertyValue
	)			[inline]

Modifies the first matching TimeSpan property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the TimeSpan property to modify.
	propertyValue	New TimeSpan property value.

void Simias::Storage::PropertyList::ModifyProperty	(	string	name,
		Relationship	propertyValue
	)			[inline]

Modifies the first matching Relationship property in the list. If the property doesn't exist, it is created.

Parameters:

	name	Name of the Relationship property to modify.
	propertyValue	New Relationship property value.

override string Simias::Storage::PropertyList::ToString

(

)

[inline]

Converts the PropertyList to a string representation.

Returns:

A string containing the contents of the property list.

string Simias::Storage::PropertyList::ToString

(

bool

stripLocalProperties

)

[inline]

Converts the PropertyList to a string representation.

Parameters:

stripLocalProperties

If true, the local properties will be stripped from the string. Otherwise the string will contain all properties.

Returns:

A string containing the contents of the property list.

string Simias::Storage::PropertyList::ToString	(	bool	stripLocalProperties,
		bool	LoggedInMember
	)			[inline]

Converts the PropertyList to a string representation, and strips local as well as client specific info.

Parameters:

stripLocalProperties

Always, the local properties will be stripped Parameters: LoggedInMember  If this is a member node and the member is currently logged in, then its true , Returns: A string containing the contents of the property list.

IEnumerator Simias::Storage::PropertyList::GetEnumerator

(

)

[inline]

Method used by clients to enumerate the properties in the list.

The client must call Dispose() to free up system resources before releasing the reference to the ICSEnumerator.

Returns:

A property object that can enumerate the property list.

virtual void Simias::Storage::PropertyList::GetObjectData	(	SerializationInfo	info,
		StreamingContext	context
	)			[inline, virtual]

Called by the ISerializable interface to serialize a Node object.

Parameters:

	info	The SerializationInfo to populate with data.
	context	The destination (see StreamingContext) for this serialization.

---

Property Documentation

XmlElement Simias::Storage::PropertyList::PropertyRoot [get]

Gets the parent element where the xml properties are stored.

int Simias::Storage::PropertyList::Count [get]

Gets the count of properties in the list not including the hidden properties.

---

The documentation for this class was generated from the following file:

• src/core/CollectionStore/PropertyList.cs