OpenMS
Loading...
Searching...
No Matches
ParquetFilterBuilder Class Reference

Fluent builder for ParquetFilter objects. More...

#include <OpenMS/FORMAT/ParquetFilter.h>

Collaboration diagram for ParquetFilterBuilder:
[legend]

Public Member Functions

 ParquetFilterBuilder ()=default
 
 ParquetFilterBuilder (const ParquetFilterBuilder &)=default
 
ParquetFilterBuilderandNext ()
 Combine the next condition with logical AND.
 
ParquetFilterBuilderorNext ()
 Combine the next condition with logical OR.
 
ParquetFilterBuildereq (const String &column, Int64 value)
 Add an equality condition for an integer column.
 
ParquetFilterBuilderne (const String &column, Int64 value)
 Add an inequality condition for an integer column.
 
ParquetFilterBuilderlt (const String &column, Int64 value)
 Add a less-than condition for an integer column.
 
ParquetFilterBuilderle (const String &column, Int64 value)
 Add a less-than-or-equal condition for an integer column.
 
ParquetFilterBuildergt (const String &column, Int64 value)
 Add a greater-than condition for an integer column.
 
ParquetFilterBuilderge (const String &column, Int64 value)
 Add a greater-than-or-equal condition for an integer column.
 
ParquetFilterBuilderin (const String &column, const std::vector< Int64 > &values)
 Add an IN condition for an integer column.
 
ParquetFilterBuildereq (const String &column, const String &value)
 Add an equality condition for a string column.
 
ParquetFilterBuilderne (const String &column, const String &value)
 Add an inequality condition for a string column.
 
ParquetFilterBuilderlt (const String &column, const String &value)
 Add a less-than condition for a string column.
 
ParquetFilterBuilderle (const String &column, const String &value)
 Add a less-than-or-equal condition for a string column.
 
ParquetFilterBuildergt (const String &column, const String &value)
 Add a greater-than condition for a string column.
 
ParquetFilterBuilderge (const String &column, const String &value)
 Add a greater-than-or-equal condition for a string column.
 
ParquetFilterBuilderin (const String &column, const std::vector< String > &values)
 Add an IN condition for a string column.
 
const ParquetFilterfilter () const
 Return the built filter.
 
bool empty () const
 Return whether the filter is empty.
 

Private Attributes

ParquetFilter filter_
 

Detailed Description

Fluent builder for ParquetFilter objects.

This builder offers a stable, chainable interface for constructing typed filters that can be passed to Parquet-backed readers. It wraps a ParquetFilter instance and forwards all condition-building operations.

Example

using namespace OpenMS;
f.eq("PRECURSOR_ID", 1318)
.eq("ANNOTATION", "y3^1");
// Pass f.filter() into Parquet-backed readers.
Fluent builder for ParquetFilter objects.
Definition ParquetFilter.h:240
ParquetFilterBuilder & andNext()
Combine the next condition with logical AND.
ParquetFilterBuilder & eq(const String &column, Int64 value)
Add an equality condition for an integer column.
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19

Constructor & Destructor Documentation

◆ ParquetFilterBuilder() [1/2]

ParquetFilterBuilder ( )
default

◆ ParquetFilterBuilder() [2/2]

Member Function Documentation

◆ andNext()

ParquetFilterBuilder & andNext ( )

Combine the next condition with logical AND.

◆ empty()

bool empty ( ) const

Return whether the filter is empty.

◆ eq() [1/2]

ParquetFilterBuilder & eq ( const String column,
const String value 
)

Add an equality condition for a string column.

Parameters
columnColumn name.
valueString value to compare.

◆ eq() [2/2]

ParquetFilterBuilder & eq ( const String column,
Int64  value 
)

Add an equality condition for an integer column.

Parameters
columnColumn name.
valueInteger value to compare.

◆ filter()

const ParquetFilter & filter ( ) const

Return the built filter.

Returns
ParquetFilter instance.

◆ ge() [1/2]

ParquetFilterBuilder & ge ( const String column,
const String value 
)

Add a greater-than-or-equal condition for a string column.

Parameters
columnColumn name.
valueString value to compare.

◆ ge() [2/2]

ParquetFilterBuilder & ge ( const String column,
Int64  value 
)

Add a greater-than-or-equal condition for an integer column.

Parameters
columnColumn name.
valueInteger value to compare.

◆ gt() [1/2]

ParquetFilterBuilder & gt ( const String column,
const String value 
)

Add a greater-than condition for a string column.

Parameters
columnColumn name.
valueString value to compare.

◆ gt() [2/2]

ParquetFilterBuilder & gt ( const String column,
Int64  value 
)

Add a greater-than condition for an integer column.

Parameters
columnColumn name.
valueInteger value to compare.

◆ in() [1/2]

ParquetFilterBuilder & in ( const String column,
const std::vector< Int64 > &  values 
)

Add an IN condition for an integer column.

Parameters
columnColumn name.
valuesInteger values to compare.

◆ in() [2/2]

ParquetFilterBuilder & in ( const String column,
const std::vector< String > &  values 
)

Add an IN condition for a string column.

Parameters
columnColumn name.
valuesString values to compare.

◆ le() [1/2]

ParquetFilterBuilder & le ( const String column,
const String value 
)

Add a less-than-or-equal condition for a string column.

Parameters
columnColumn name.
valueString value to compare.

◆ le() [2/2]

ParquetFilterBuilder & le ( const String column,
Int64  value 
)

Add a less-than-or-equal condition for an integer column.

Parameters
columnColumn name.
valueInteger value to compare.

◆ lt() [1/2]

ParquetFilterBuilder & lt ( const String column,
const String value 
)

Add a less-than condition for a string column.

Parameters
columnColumn name.
valueString value to compare.

◆ lt() [2/2]

ParquetFilterBuilder & lt ( const String column,
Int64  value 
)

Add a less-than condition for an integer column.

Parameters
columnColumn name.
valueInteger value to compare.

◆ ne() [1/2]

ParquetFilterBuilder & ne ( const String column,
const String value 
)

Add an inequality condition for a string column.

Parameters
columnColumn name.
valueString value to compare.

◆ ne() [2/2]

ParquetFilterBuilder & ne ( const String column,
Int64  value 
)

Add an inequality condition for an integer column.

Parameters
columnColumn name.
valueInteger value to compare.

◆ orNext()

ParquetFilterBuilder & orNext ( )

Combine the next condition with logical OR.

Member Data Documentation

◆ filter_

ParquetFilter filter_
private