---

corelinux::Store Class Reference

Store is a logical storage backing object. More...

#include <Store.hpp>

Inheritance diagram for corelinux::Store:

List of all members.

Public Methods
virtual MetaTypeCptr	getType ( void ) const
	get the type. More...
VoidPtr	operator new (size_t aSize)
	redefine the operator new[] aSize. More...
void	operator delete (VoidPtr aVoidPtr)
	redefine the operator delete[] aVoidPtr the pointer to delete.
	Store ( void )
	Default constructor not allowed.
	Store ( StoreCref )
	Copy constructor.
virtual	~Store ( void )
	Virtual Destructor.
bool	operator== ( StoreCref ) const
	Equality operator.
StoreRef	operator= ( StoreCref )
	Assignment operator.
virtual void	open ( CollectionPtr ) = 0
	open the store, using the arguments. More...
virtual void	close ( void ) = 0
	close the store.
virtual CollectionPtr	read ( CollectionPtr ) = 0
	Read one or more objects from a store. More...
virtual void	returnReadCollection ( CollectionPtr ) = 0
	Returns a collection created by virtue of calling a read operation. More...
virtual void	write ( CollectionPtr ) = 0
	Write one or more objects to a store. More...
virtual void	remove ( CollectionPtr ) = 0
	Remove one or more object from a store. More...
Static Public Methods
MetaTypeCptr	getTypeDescriptor ( void )
	get the type descriptor. More...
	StorePtr ( void )
	1 a new instance of Store. More...
	void ( StorePtr aPointer )
	1 a point of Store pointer to Store.
FrameworkStringPtr	resolveValueAssignment ( CollectionPtr, FrameworkStringCptr )
	General function to resolve attribute from collection. More...
FrameworkStringCref	getNameKey ( void )
FrameworkStringCref	getModeKey ( void )
FrameworkStringCref	getLocationKey ( void )
FrameworkStringCref	getUniqueIdKey ( void )
FrameworkStringCref	getClassIdKey ( void )
FrameworkStringCref	getCollectionKey ( void )

---

Detailed Description

Store is a logical storage backing object.

---

Constructor & Destructor Documentation

corelinux::Store::Store ( void )

Default constructor not allowed.

corelinux::Store::Store ( StoreCref aType )

Copy constructor.

corelinux::Store::~Store ( void ) [virtual]

Virtual Destructor.

---

Member Function Documentation

corelinux::Store::StorePtr ( void ) [static]

1 a new instance of Store. Returns: a pointer to Store

void corelinux::Store::close ( void ) [pure virtual]

close the store. Reimplemented in corelinux::SchemaCatStore, and corelinux::SchemaStore.

FrameworkStringCref corelinux::Store::getClassIdKey ( void ) [static]

FrameworkStringCref corelinux::Store::getCollectionKey ( void ) [static]

FrameworkStringCref corelinux::Store::getLocationKey ( void ) [static]

FrameworkStringCref corelinux::Store::getModeKey ( void ) [static]

FrameworkStringCref corelinux::Store::getNameKey ( void ) [static]

MetaTypeCptr corelinux::Store::getType ( void ) const [virtual]

get the type. Returns: a const pointer to the MetaType Reimplemented from corelinux::Aggregate. Reimplemented in corelinux::SchemaAbstractStore, corelinux::SchemaCatStore, and corelinux::SchemaStore.

MetaTypeCptr corelinux::Store::getTypeDescriptor ( void ) [static]

get the type descriptor. Returns: a const pointer to the MetaType Reimplemented from corelinux::Aggregate. Reimplemented in corelinux::SchemaAbstractStore, corelinux::SchemaCatStore, and corelinux::SchemaStore.

FrameworkStringCref corelinux::Store::getUniqueIdKey ( void ) [static]

void corelinux::Store::open ( CollectionPtr aPtr ) [pure virtual]

open the store, using the arguments. Parameters: Collection   of corelinux::Attributes, with common key/value pairs as: "Name" - Name of Store "Location" - Specific location details "Mode" - "Read | Write | ReadWrite" "Schema" - corelinux::Schema model for store "UserId" - Identifiers the user "AliasId" - As alias "Password" - for activity Reimplemented in corelinux::SchemaCatStore, and corelinux::SchemaStore.

void corelinux::Store::operator delete ( VoidPtr aVoidPtr )

redefine the operator delete[] aVoidPtr the pointer to delete. Reimplemented from corelinux::Aggregate. Reimplemented in corelinux::SchemaAbstractStore, corelinux::SchemaCatStore, and corelinux::SchemaStore.

VoidPtr corelinux::Store::operator new ( size_t aSize )

redefine the operator new[] aSize. Returns: a VoidPtr Reimplemented from corelinux::Aggregate. Reimplemented in corelinux::SchemaAbstractStore, corelinux::SchemaCatStore, and corelinux::SchemaStore.

StoreRef corelinux::Store::operator= ( StoreCref )

Assignment operator. Reimplemented in corelinux::SchemaAbstractStore, corelinux::SchemaCatStore, and corelinux::SchemaStore.

bool corelinux::Store::operator== ( StoreCref aStore ) const

Equality operator.

CollectionPtr corelinux::Store::read ( CollectionPtr aPtr ) [pure virtual]

Read one or more objects from a store. Parameters: Collection   pointer to identifications Returns: Collection of resolutions Reimplemented in corelinux::SchemaCatStore, and corelinux::SchemaStore.

void corelinux::Store::remove ( CollectionPtr aCollection ) [pure virtual]

Remove one or more object from a store. Parameters: Collection   pointer to identifications and objects Reimplemented in corelinux::SchemaCatStore, and corelinux::SchemaStore.

FrameworkStringPtr corelinux::Store::resolveValueAssignment ( CollectionPtr aCollection, FrameworkStringCptr aValue ) [static]

General function to resolve attribute from collection. Parameters: Collection   from user FrameworkString   for key to search on Returns: FrameworkString value that goes with key

void corelinux::Store::returnReadCollection ( CollectionPtr aPtr ) [pure virtual]

Returns a collection created by virtue of calling a read operation. Parameters: Collection   pointer from Store::read Reimplemented in corelinux::SchemaCatStore, and corelinux::SchemaStore.

corelinux::Store::void ( StorePtr aPointer ) [static]

1 a point of Store pointer to Store.

void corelinux::Store::write ( CollectionPtr aCollection ) [pure virtual]

Write one or more objects to a store. Parameters: Collection   pointer to identifications and objects Reimplemented in corelinux::SchemaCatStore, and corelinux::SchemaStore.

---

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

• Store.hpp
• Store.cpp

---

This is the CoreLinux++ Framework reference manual
Provided by The CoreLinux Consortium