This is the abstract factory for cache policy. More...

#include <AbstractCachePolicyFactory.h>

Inheritance diagram for te::graph::AbstractCachePolicyFactory:

Public Types
typedef FactoryDictionary< AbstractFactory< AbstractCachePolicy, std::string, std::less< std::string > >, std::string, std::less< std::string > >	dictionary_type

typedef AbstractFactory	factory_type

Public Member Functions
const std::string &	getKey () const
	It returns the factory key associated to the concreate factory. More...

virtual const std::string &	getType () const =0
	Returns the type (name) of this factory. More...

virtual	~AbstractCachePolicyFactory ()
	Destructor. More...

Static Public Member Functions
static const factory_type *	find (const std::string &factoryKey)

static dictionary_type &	getDictionary ()
	It returns a reference to the internal dictionary of concrete factories. More...

static AbstractCachePolicy *	make ()
	It creates and returns default cache policy. More...

static AbstractCachePolicy *	make (const std::string &cpType)
	It creates a cache policy with the proper type. More...

static AbstractCachePolicy *	make (const std::string &factoryKey)
	It creates an object with the appropriated factory. More...

Protected Member Functions
	AbstractCachePolicyFactory (const std::string &factoryKey)
	Constructor. More...

virtual AbstractCachePolicy *	build ()=0
	Concrete factories (derived from this one) must implement this method in order to create objects. More...

Protected Attributes
std::string	m_factoryKey
	The key that identifies the concrete factory: it will be used for unregistering the factory during destruction. More...

Detailed Description

This is the abstract factory for cache policy.

See also: AbstractGraph

Definition at line 49 of file AbstractCachePolicyFactory.h.

Member Typedef Documentation

◆ dictionary_type

typedef FactoryDictionary<AbstractFactory<AbstractCachePolicy , std::string , std::less<std::string > >, std::string , std::less<std::string > > te::common::AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::dictionary_type

inherited

Definition at line 73 of file AbstractFactory.h.

◆ factory_type

typedef AbstractFactory te::common::AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::factory_type

inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

◆ ~AbstractCachePolicyFactory()

virtual te::graph::AbstractCachePolicyFactory::~AbstractCachePolicyFactory ( )

inlinevirtual

Destructor.

Definition at line 75 of file AbstractCachePolicyFactory.h.

◆ AbstractCachePolicyFactory()

te::graph::AbstractCachePolicyFactory::AbstractCachePolicyFactory ( const std::string & factoryKey )

protected

Constructor.

Parameters

factoryKey The key that identifies the factory.

Member Function Documentation

◆ build()

virtual AbstractCachePolicy * te::common::AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::build ( )

protectedpure virtualinherited

Concrete factories (derived from this one) must implement this method in order to create objects.

Returns: It returns an object created by the concrete factory.

Implemented in te::graph::LFUCachePolicyFactory, and te::graph::FIFOCachePolicyFactory.

◆ find()

const AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::factory_type * te::common::AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::find ( const std::string & factoryKey )

inlinestaticinherited

Definition at line 108 of file AbstractFactory.h.

◆ getDictionary()

AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::dictionary_type & te::common::AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::getDictionary

inlinestaticinherited

It returns a reference to the internal dictionary of concrete factories.

The dictionary is a singleton.

Returns: A reference to the internal dictionary.

Definition at line 106 of file AbstractFactory.h.

◆ getKey()

const std::string & te::common::AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::getKey

inlineinherited

It returns the factory key associated to the concreate factory.

Returns: The factory key associated to the concreate factory.

Definition at line 84 of file AbstractFactory.h.

◆ getType()

virtual const std::string& te::graph::AbstractCachePolicyFactory::getType ( ) const

pure virtual

Returns the type (name) of this factory.

Implemented in te::graph::LFUCachePolicyFactory, and te::graph::FIFOCachePolicyFactory.

◆ make() [1/3]

static AbstractCachePolicy* te::graph::AbstractCachePolicyFactory::make ( )

static

It creates and returns default cache policy.

Returns: A default cache policy

Note: The caller will take the ownership of the returned pointer.

◆ make() [2/3]

static AbstractCachePolicy* te::graph::AbstractCachePolicyFactory::make ( const std::string & cpType )

static

It creates a cache policy with the proper type.

Parameters

cpType The name of the specific cache policy.

Returns: A specific cache policy

Note: The caller will take the ownership of the returned pointer.

◆ make() [3/3]

AbstractCachePolicy * te::common::AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::make ( const std::string & factoryKey )

inlinestaticinherited

It creates an object with the appropriated factory.

Parameters

factoryKey A key that identifies the factory used to build the object.

Returns: It returns a new object created by the given factory.

Exceptions

Exception If the concrete factory is not specified or the object can not be built for any reason this methiod may throws an exception.

Note: The caller of this method will take the ownership of the returned object.

Definition at line 97 of file AbstractFactory.h.

Member Data Documentation

◆ m_factoryKey

std::string te::common::AbstractFactory< AbstractCachePolicy , std::string , std::less<std::string > >::m_factoryKey

protectedinherited

The key that identifies the concrete factory: it will be used for unregistering the factory during destruction.

Definition at line 136 of file AbstractFactory.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/graph/cache/AbstractCachePolicyFactory.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ dictionary_type

◆ factory_type

Constructor & Destructor Documentation

◆ ~AbstractCachePolicyFactory()

◆ AbstractCachePolicyFactory()

Member Function Documentation

◆ build()

◆ find()

◆ getDictionary()

◆ getKey()

◆ getType()

◆ make() [1/3]

◆ make() [2/3]

◆ make() [3/3]

Member Data Documentation

◆ m_factoryKey