Package io.gdcc.spi.export

Class DatasetExportQuery.Builder

java.lang.Object

io.gdcc.spi.export.DatasetExportQuery.Builder

Enclosing class:

DatasetExportQuery

public static class DatasetExportQuery.Builder
extends Object

Builder for DatasetExportQuery.

Obtain an instance via DatasetExportQuery.builder() or from(DatasetExportQuery) to derive a new query from an existing one.

Method Summary

Modifier and Type	Method	Description
DatasetExportQuery.Builder	addDatasetPredicate(DatasetMetadataPredicates predicate)	Adds a dataset metadata predicate to the builder's collection of predicates.
DatasetExportQuery	build()	Builds an immutable DatasetExportQuery.
DatasetExportQuery.Builder	datasetPredicates(DatasetMetadataPredicates... predicates)	Sets the dataset metadata predicates, replacing any previously set predicates.
DatasetExportQuery.Builder	datasetPredicates(Collection<DatasetMetadataPredicates> predicates)	Sets the dataset metadata predicates, replacing any previously set predicates.
DatasetExportQuery.Builder	fileQuery(FileExportQuery fileQuery)	Sets the FileExportQuery to use for shaping file metadata nested within this dataset query.
DatasetExportQuery.Builder	from(DatasetExportQuery source)	Creates a new DatasetExportQuery.Builder pre-populated with the state of the given query, useful for deriving a modified copy without altering the original.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

datasetPredicates

public DatasetExportQuery.Builder datasetPredicates(DatasetMetadataPredicates... predicates)

Sets the dataset metadata predicates, replacing any previously set predicates.

Parameters:

predicates - the dataset metadata predicates to set

Returns:

this builder instance

datasetPredicates

public DatasetExportQuery.Builder datasetPredicates(Collection<DatasetMetadataPredicates> predicates)

Sets the dataset metadata predicates, replacing any previously set predicates.

Parameters:

predicates - the dataset metadata predicates to set

Returns:

this builder instance

addDatasetPredicate

public DatasetExportQuery.Builder addDatasetPredicate(DatasetMetadataPredicates predicate)

Adds a dataset metadata predicate to the builder's collection of predicates.

Parameters:

predicate - the dataset metadata predicate to add

Returns:

this builder instance

fileQuery

public DatasetExportQuery.Builder fileQuery(FileExportQuery fileQuery)

Sets the FileExportQuery to use for shaping file metadata nested within this dataset query. Replaces any previously set file query.

If not set, methods that include file metadata will apply their own defaults.

Parameters:

fileQuery - the file export query to compose into this dataset query

Returns:

this builder instance

build

public DatasetExportQuery build()

Builds an immutable DatasetExportQuery.

Returns:

a new, validated DatasetExportQuery

Throws:

IllegalArgumentException - if the predicate combination is invalid, e.g. due to conflicting predicates

from

public DatasetExportQuery.Builder from(DatasetExportQuery source)

Creates a new DatasetExportQuery.Builder pre-populated with the state of the given query, useful for deriving a modified copy without altering the original.

Parameters:

source - the DatasetExportQuery instance to copy from

Returns:

a new Builder with the same predicates and file query as source