---

corelinux::SchemaCatalog Class Reference

A SchemaCatalog represents a view over the Schemas in a storage domain. More...

#include <SchemaCatalog.hpp>

Inheritance diagram for corelinux::SchemaCatalog:

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.
	SchemaCatalog ( void )
	Default constructor not allowed.
	SchemaCatalog ( SchemaCatalogCref )
	Copy constructor.
virtual	~SchemaCatalog ( void )
	Virtual Destructor.
bool	operator== ( SchemaCatalogCref ) const
	Equality operator.
SchemaCatalogRef	operator= ( SchemaCatalogCref )
	Assignment operator.
virtual Counter	getCount ( void ) const
	Retrieve the count of catalog elements.
virtual FrameworkEntityPtr	getEntry ( CollectionPtr ) const
	Fetch a Schema based on attributes provided in the collection. More...
virtual void	createEntry ( CollectionPtr )
	Create a new schema and add entry in the catalog. More...
virtual void	deleteEntry ( CollectionPtr )
	Delete a Schema and it's entry in the catalog. More...
virtual Iterator<FrameworkEntityPtr>*	createCatalogIterator ( void )
	Create an iterator over the catalog entries as defined by the catalog type, for this case it is an iterator which returns a FrameworkStringPtr, which is the name of the Schema which the entry represents. More...
virtual void	destroyIterator ( Iterator<FrameworkEntityPtr> * )
	Destroy the iterator over the catalog entries.
virtual void	saveEntries ( CollectionPtr )
	Save the entries (Schemas) in the collection.
virtual void	closeEntries ( CollectionPtr )
	Close the entries (Schemas) in the collection.
Static Public Methods
MetaTypeCptr	getTypeDescriptor ( void )
	get the type descriptor. More...
	SchemaCatalogPtr ( void )
	1 a new instance of SchemaCatalog. More...
	void ( SchemaCatalogPtr aPointer )
	1 a point of SchemaCatalog pointer to SchemaCatalog.

---

Detailed Description

A SchemaCatalog represents a view over the Schemas in a storage domain.

---

Constructor & Destructor Documentation

corelinux::SchemaCatalog::SchemaCatalog ( void )

Default constructor not allowed.

corelinux::SchemaCatalog::SchemaCatalog ( SchemaCatalogCref aType )

Copy constructor.

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

Virtual Destructor.

---

Member Function Documentation

corelinux::SchemaCatalog::SchemaCatalogPtr ( void ) [static]

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

void corelinux::SchemaCatalog::closeEntries ( CollectionPtr aCollection ) [virtual]

Close the entries (Schemas) in the collection. Reimplemented from corelinux::StoreCatalog.

Iterator< FrameworkEntityPtr >* corelinux::SchemaCatalog::createCatalogIterator ( void ) [virtual]

Create an iterator over the catalog entries as defined by the catalog type, for this case it is an iterator which returns a FrameworkStringPtr, which is the name of the Schema which the entry represents. Returns: Iterator pointer to FrameworkString pointers Reimplemented from corelinux::Catalog.

void corelinux::SchemaCatalog::createEntry ( CollectionPtr aCollection ) [virtual]

Create a new schema and add entry in the catalog. Parameters: SetCollection   a collection of corelinux::Attribute valid Schema creation attributes are: "Name" - Defines the name of the schema "Location" - Can designate where the actual schema resides "Collection" - Defines the type collection class name (e.g. SetCollection) to use for the new schema "GUID" - (optional) provides the stringified UniversalUniqueIdentifier to use instead of generating one Reimplemented from corelinux::Catalog.

void corelinux::SchemaCatalog::deleteEntry ( CollectionPtr aCollection ) [virtual]

Delete a Schema and it's entry in the catalog. Parameters: corelinux::Collection   a collection of corelinux::Attribute valid Schema delete attributes are: "Name" - The name of the schema "GUID" - (optional) The stringified UniversalUniqueIdentifier that identifies the schema Reimplemented from corelinux::Catalog.

void corelinux::SchemaCatalog::destroyIterator ( Iterator< FrameworkEntityPtr >* aPtr ) [virtual]

Destroy the iterator over the catalog entries. Reimplemented from corelinux::Catalog.

Counter corelinux::SchemaCatalog::getCount ( void ) const [virtual]

Retrieve the count of catalog elements. Reimplemented from corelinux::Catalog.

FrameworkEntityPtr corelinux::SchemaCatalog::getEntry ( CollectionPtr aCollection ) const [virtual]

Fetch a Schema based on attributes provided in the collection. Parameters: corelinux::Collection   a collection of corelinux::Attribute valid Schema get attributes are: "Name" - Defines the name of the schema "GUID" - (optional) provides the stringified UniversalUniqueIdentifier that identifies the schema Returns: corelinux::Schema pointer to actual schema Reimplemented from corelinux::Catalog.

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

get the type. Returns: a const pointer to the MetaType Reimplemented from corelinux::StoreCatalog.

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

get the type descriptor. Returns: a const pointer to the MetaType Reimplemented from corelinux::StoreCatalog.

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

redefine the operator delete[] aVoidPtr the pointer to delete. Reimplemented from corelinux::StoreCatalog.

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

redefine the operator new[] aSize. Returns: a VoidPtr Reimplemented from corelinux::StoreCatalog.

SchemaCatalogRef corelinux::SchemaCatalog::operator= ( SchemaCatalogCref )

Assignment operator. Reimplemented from corelinux::StoreCatalog.

bool corelinux::SchemaCatalog::operator== ( SchemaCatalogCref aSchemaCatalog ) const

Equality operator.

void corelinux::SchemaCatalog::saveEntries ( CollectionPtr aCollection ) [virtual]

Save the entries (Schemas) in the collection. Reimplemented from corelinux::StoreCatalog.

corelinux::SchemaCatalog::void ( SchemaCatalogPtr aPointer ) [static]

1 a point of SchemaCatalog pointer to SchemaCatalog.

---

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

• SchemaCatalog.hpp
• SchemaCatalog.cpp

---

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