Package io.gdcc.spi.export

Class DatasetExportQuery

java.lang.Object

io.gdcc.spi.export.DatasetExportQuery

public final class DatasetExportQuery
extends Object

Defines what dataset metadata to retrieve and at what level of detail for dataset-oriented export operations.

This is a pure data-shape specification: it answers which aspects of a dataset should be included in an export, and optionally how file metadata nested within that dataset should be shaped. It deliberately does not address which datasets to operate on (that is a selection concern at a higher level), nor how much data to retrieve per call — pagination is a separate, orthogonal concern expressed via a PageRequest at the method level.

File metadata shaping is optional: if no FileExportQuery is provided at build time, FileExportQuery.none() is included, resulting in file metadata addition being skipped.

Instances are immutable and must be constructed via builder(). Use defaults() for the standard query with no special filtering and skipping files.

See Also:

• FileExportQuery
• DatasetMetadataPredicates

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatasetExportQuery.Builder	Builder for DatasetExportQuery.

Method Summary

Modifier and Type	Method	Description
static DatasetExportQuery.Builder	builder()	Returns a builder for creating new queries.
static DatasetExportQuery.Builder	builder(DatasetExportQuery source)	Creates a new DatasetExportQuery.Builder pre-populated with the state of the given query.
static DatasetExportQuery	defaults()	Returns the default query, which includes all dataset metadata with no special filtering, and defers file metadata shaping to method-level defaults.
boolean	equals(Object o)
FileExportQuery	fileQuery()	Returns the FileExportQuery that controls how file metadata nested within this dataset export should be shaped.
int	hashCode()
Set<DatasetMetadataPredicates>	predicates()	Returns the dataset metadata predicates that control which aspects of the dataset are included in the export.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static DatasetExportQuery.Builder builder()

Returns a builder for creating new queries.

Returns:

a new DatasetExportQuery.Builder instance

builder

public static DatasetExportQuery.Builder builder(DatasetExportQuery source)

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

Parameters:

source - the DatasetExportQuery instance to copy from

Returns:

a new DatasetExportQuery.Builder instance pre-configured with the same predicates and file query as the provided source

defaults

public static DatasetExportQuery defaults()

Returns the default query, which includes all dataset metadata with no special filtering, and defers file metadata shaping to method-level defaults.

Returns:

the shared default DatasetExportQuery instance

predicates

public Set<DatasetMetadataPredicates> predicates()

Returns the dataset metadata predicates that control which aspects of the dataset are included in the export.

Returns:

an unmodifiable set of DatasetMetadataPredicates; never null

fileQuery

public FileExportQuery fileQuery()

Returns the FileExportQuery that controls how file metadata nested within this dataset export should be shaped.

The default value is FileExportQuery.none(), resulting in no file metadata being queried.

Returns:

an Optional containing the file export query

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object