#include <Rootcollection/RNTCollectionQuery.h>

Inheritance diagram for pool::RootCollection::RNTCollectionQuery:

Collaboration diagram for pool::RootCollection::RNTCollectionQuery:

Public Member Functions
	RNTCollectionQuery (const pool::ICollectionDescription &description, RNTupleReader *reader)
	Constructor. More...

virtual	~RNTCollectionQuery ()
	Destructor. More...

virtual void	addToOutputList (const std::string &columnName)
	Adds a column to the query select list. More...

virtual void	addToOutputList (const std::vector< std::string > &columnNames)
	Adds one or more columns to the query select list. More...

virtual void	selectAllAttributes ()
	Adds all Attribute columns to the query select list. More...

virtual void	selectAllTokens ()
	Adds all Token columns to the query select list. More...

virtual void	selectAll ()
	Adds all Token and Attribute columns to the query select list. More...

virtual void	setCondition (const std::string &whereClause, coral::AttributeList attributeBindData=0, TokenList tokenBindData=0)
	Sets the query. More...

virtual const std::string &	whereClause () const
	Returns the where clause of the query. More...

virtual void	setRowCacheSize (int rowCacheSize)
	Sets the cache size used to store the query result. More...

virtual pool::ICollectionCursor &	execute ()
	Processes the query and returns a cursor over the query result. More...

virtual void	skipEventReference (bool=true)
	Tell the query to not include the primary event reference in the result by default (it can still beselected manually) More...

Protected Member Functions
void	addToTokenOutputList (const std::string &columnName)

void	addToAttributeOutputList (const std::string &columnName)

Protected Attributes
const ICollectionDescription &	m_description

RNTupleReader *	m_reader {nullptr}

RNTCollectionCursor *	m_cursor {nullptr}

std::string	m_whereClause

pool::TokenList	m_outputTokenList

coral::AttributeList	m_outputAttributeList

std::set< std::string >	m_selectedColumnNames

bool	m_skipEventRef
	If false, the primary event reference is added always to the query result. More...

Detailed Description

An interface used to query an RNTuple collection.

Definition at line 26 of file RNTCollectionQuery.h.

Constructor & Destructor Documentation

◆ RNTCollectionQuery()

pool::RootCollection::RNTCollectionQuery::RNTCollectionQuery	(	const pool::ICollectionDescription &	description,
		RNTupleReader *	reader
	)

Constructor.

◆ ~RNTCollectionQuery()

virtual pool::RootCollection::RNTCollectionQuery::~RNTCollectionQuery ( )

virtual

Destructor.

Member Function Documentation

◆ addToAttributeOutputList()

void pool::RootCollection::RNTCollectionQuery::addToAttributeOutputList ( const std::string & columnName )

protected

◆ addToOutputList() [1/2]

virtual void pool::RootCollection::RNTCollectionQuery::addToOutputList ( const std::string & columnName )

virtual

Adds a column to the query select list.

Parameters

columnName Name of Attribute column to select.

Implements pool::ICollectionQuery.

◆ addToOutputList() [2/2]

virtual void pool::RootCollection::RNTCollectionQuery::addToOutputList ( const std::vector< std::string > & columnNames )

virtual

Adds one or more columns to the query select list.

Parameters

columnNames Names of Attribute columns to select.

Implements pool::ICollectionQuery.

◆ addToTokenOutputList()

void pool::RootCollection::RNTCollectionQuery::addToTokenOutputList ( const std::string & columnName )

protected

◆ execute()

virtual pool::ICollectionCursor& pool::RootCollection::RNTCollectionQuery::execute ( )

virtual

Processes the query and returns a cursor over the query result.

Implements pool::ICollectionQuery.

◆ selectAll()

virtual void pool::RootCollection::RNTCollectionQuery::selectAll ( )

virtual

Adds all Token and Attribute columns to the query select list.

Implements pool::ICollectionQuery.

◆ selectAllAttributes()

virtual void pool::RootCollection::RNTCollectionQuery::selectAllAttributes ( )

virtual

Adds all Attribute columns to the query select list.

Implements pool::ICollectionQuery.

◆ selectAllTokens()

virtual void pool::RootCollection::RNTCollectionQuery::selectAllTokens ( )

virtual

Adds all Token columns to the query select list.

Implements pool::ICollectionQuery.

◆ setCondition()

virtual void pool::RootCollection::RNTCollectionQuery::setCondition	(	const std::string &	whereClause,
		coral::AttributeList *	attributeBindData = `0`,
		TokenList *	tokenBindData = `0`
	)

virtual

Sets the query.

the query can be constructed in fragments by repeated calls to ‘setCondition’.

Parameters

whereClause	The query.
attributeBindData	- unused
tokenBindData	- unused

Implements pool::ICollectionQuery.

◆ setRowCacheSize()

virtual void pool::RootCollection::RNTCollectionQuery::setRowCacheSize ( int rowCacheSize )

virtual

Sets the cache size used to store the query result.

Parameters

Number of rows stored in cache before cache is flushed.

Implements pool::ICollectionQuery.

◆ skipEventReference()

virtual void pool::RootCollection::RNTCollectionQuery::skipEventReference ( bool = true )

virtual

Tell the query to not include the primary event reference in the result by default (it can still beselected manually)

Parameters

skip	if true (the default) then skip the primary event reference

Reimplemented from pool::ICollectionQuery.

◆ whereClause()

virtual const std::string& pool::RootCollection::RNTCollectionQuery::whereClause ( ) const

virtual

Returns the where clause of the query.

Implements pool::ICollectionQuery.

Member Data Documentation

◆ m_cursor

RNTCollectionCursor* pool::RootCollection::RNTCollectionQuery::m_cursor {nullptr}

protected

Definition at line 102 of file RNTCollectionQuery.h.

◆ m_description

const ICollectionDescription& pool::RootCollection::RNTCollectionQuery::m_description

protected

Definition at line 99 of file RNTCollectionQuery.h.

◆ m_outputAttributeList

coral::AttributeList pool::RootCollection::RNTCollectionQuery::m_outputAttributeList

protected

Definition at line 107 of file RNTCollectionQuery.h.

◆ m_outputTokenList

pool::TokenList pool::RootCollection::RNTCollectionQuery::m_outputTokenList

protected

Definition at line 106 of file RNTCollectionQuery.h.

◆ m_reader

RNTupleReader* pool::RootCollection::RNTCollectionQuery::m_reader {nullptr}

protected

Definition at line 100 of file RNTCollectionQuery.h.

◆ m_selectedColumnNames

std::set< std::string > pool::RootCollection::RNTCollectionQuery::m_selectedColumnNames

protected

Definition at line 109 of file RNTCollectionQuery.h.

◆ m_skipEventRef

bool pool::RootCollection::RNTCollectionQuery::m_skipEventRef

protected

If false, the primary event reference is added always to the query result.

Definition at line 112 of file RNTCollectionQuery.h.

◆ m_whereClause

std::string pool::RootCollection::RNTCollectionQuery::m_whereClause

protected

Definition at line 104 of file RNTCollectionQuery.h.

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

RNTCollectionQuery.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RNTCollectionQuery()

◆ ~RNTCollectionQuery()

Member Function Documentation

◆ addToAttributeOutputList()

◆ addToOutputList() [1/2]

◆ addToOutputList() [2/2]

◆ addToTokenOutputList()

◆ execute()

◆ selectAll()

◆ selectAllAttributes()

◆ selectAllTokens()

◆ setCondition()

◆ setRowCacheSize()

◆ skipEventReference()

◆ whereClause()

Member Data Documentation

◆ m_cursor

◆ m_description

◆ m_outputAttributeList

◆ m_outputTokenList

◆ m_reader

◆ m_selectedColumnNames

◆ m_skipEventRef

◆ m_whereClause