AftDeleteEntry Class Reference

Class used to delete the referenced entry. More...

#include <AftEntry.h>

Inheritance diagram for AftDeleteEntry:

Public Member Functions
	AftDeleteEntry (const AftNodeToken delParentNode, const AftKey delEntryKey)
	Construct a deletion entry for a container node. More...
	AftDeleteEntry (const AftNodeToken delParentNode, const AftIndex delEntryIndex)
	Construct a deletion entry for a container node. More...
	AftDeleteEntry (const AftNodeToken delParentNode, const AftKeyVector delEntryKeys)
	Construct a deletion entry for a container node. More...
virtual const bool	entryIsValid (const AftValidatorPtr &validator, std::ostream &os)
	@ returns true if entry is valid
virtual const std::string	entryType () const
virtual const bool	entryIsDelete () const
	@ returns true if entry is a delete
Public Member Functions inherited from AftEntry
	AftEntry (const AftNodeToken newParentNode, const AftKey newKey, const AftNodeToken newEntryNode)
	Construct an entry for a container node. More...
	_entryNode (newEntryNode)
	AftEntry (const AftNodeToken newParentNode, const AftKeyVector newKeys, const AftNodeToken newEntryNode)
	Construct an entry for a container node. More...
	AftEntry (const AftNodeToken newParentNode, const AftIndex newEntryIndex, const AftNodeToken newEntryNode)
	Construct an indexed entry. More...
const AftNodeToken	parentNode () const
const AftKeyVector &	entryKeys () const
const AftNodeToken	entryNode () const
void	setEntryParameters (const AftParameters::Ptr &newParams)
	Set the optional parameters of the entry. More...
const AftParameters::Ptr	entryParameters () const
template<class T >
std::shared_ptr< T >	entryParameter (const std::string &name)
	Convenience parameter access template. Use this to access entry parameters. More...
void	setEntryParameter (const std::string &name, const AftDataPtr &data)
	Convenience parameter setter. Use this to set entry parameters. More...
virtual void	nextNodes (AftTokenVector &nextTokens)
virtual std::ostream &	description (std::ostream &os) const
	Append a description of the entry to an output stream. More...

Static Public Member Functions
static AftDeleteEntryPtr	create (const AftEntryPtr &entry)
	Factory generate a deletion entry for a container node. More...
static AftDeleteEntryPtr	create (const AftNodeToken delParentNode, const AftKey delEntryKey)
	Factory generate a deletion entry for a container node. More...
static AftDeleteEntryPtr	create (const AftNodeToken delParentNode, const AftKeyVector delEntryKeys)
	Factory generate a deletion entry for a container node. More...
static AftDeleteEntryPtr	create (const AftNodeToken delParentNode, const AftIndex delEntryIndex)
	Factory generator for an indexed entry. More...
Static Public Member Functions inherited from AftEntry
static AftEntryPtr	create (const AftNodeToken newParentNode, const AftKeyVector newKeys, const AftNodeToken newEntryNode)
	Factory generator for an entry for a container node. More...
static AftEntryPtr	create (const AftNodeToken newParentNode, const AftKey newKey, const AftNodeToken newEntryNode)
	Factory generator for an entry for a container node. More...
static AftEntryPtr	create (const AftNodeToken newParentNode, const AftIndex newEntryIndex, const AftNodeToken newEntryNode)
	Factory generator for an indexed entry. More...

Additional Inherited Members
Protected Attributes inherited from AftEntry
AftNodeToken	_parentNode
	Node token of the container for the entry.
AftKeyVector	_entryKeys
	Unique key values for the entry.
AftNodeToken	_entryNode
	Token for the first node to execute on a match.
AftParameters::Ptr	_entryParams
	Optional parameters for the entry.

Detailed Description

Class used to delete the referenced entry.

Constructor & Destructor Documentation

AftDeleteEntry::AftDeleteEntry ( const AftNodeToken  delParentNode, const AftKey  delEntryKey  )

inline

Construct a deletion entry for a container node.

Parameters

[in]	delParentNode	Token for parent node for entry
[in]	delEntryKey	Unique key for entry

AftDeleteEntry::AftDeleteEntry ( const AftNodeToken  delParentNode, const AftIndex  delEntryIndex  )

inline

Construct a deletion entry for a container node.

Parameters

[in]	delParentNode	Token for parent node for entry
[in]	delEntryIndex	Index of entry to remove

AftDeleteEntry::AftDeleteEntry ( const AftNodeToken  delParentNode, const AftKeyVector  delEntryKeys  )

inline

Construct a deletion entry for a container node.

Parameters

[in]	delParentNode	Token for parent node for entry
[in]	delEntryKeys	Vector of unique keys for entry

Member Function Documentation

static AftDeleteEntryPtr AftDeleteEntry::create ( const AftEntryPtr &  entry )

inlinestatic

Factory generate a deletion entry for a container node.

Parameters

[in]

entry

Reference to entry to generate a delete entry for

static AftDeleteEntryPtr AftDeleteEntry::create ( const AftNodeToken  delParentNode, const AftKey  delEntryKey  )

inlinestatic

Factory generate a deletion entry for a container node.

Parameters

[in]	delParentNode	Token for parent node for entry
[in]	delEntryKey	Unique key for entry

static AftDeleteEntryPtr AftDeleteEntry::create ( const AftNodeToken  delParentNode, const AftKeyVector  delEntryKeys  )

inlinestatic

Factory generate a deletion entry for a container node.

Parameters

[in]	delParentNode	Token for parent node for entry
[in]	delEntryKeys	Unique keys for entry

static AftDeleteEntryPtr AftDeleteEntry::create ( const AftNodeToken  delParentNode, const AftIndex  delEntryIndex  )

inlinestatic

Factory generator for an indexed entry.

Parameters

[in]	delParentNode	Token for parent node for entry
[in]	delEntryIndex	Index of entry to remove

virtual const std::string AftDeleteEntry::entryType ( ) const

inlinevirtual

Returns

Class of entry as a string

Reimplemented from AftEntry.

---

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

• AftEntry.h