BidsDataset (nf-bids 0.3.0 API)

nfneuro.model.BidsDataset

```
@groovy.transform.CompileStatic
class BidsDataset
extends java.lang.Object
```
Represents a parsed BIDS dataset.
Holds the root path, the dataset name and description loaded from dataset_description.json, the full list of BidsFile objects produced by the parser, and the participant table from participants.tsv (if present).

Provides convenience query methods (getFilesBySuffix, getFilesByEntity, getSubjects, getSessions, getSuffixes) used by the grouping handlers.

Properties Summary

Properties
Type	Name and description
`java.util.Map<java.lang.String, java.lang.Object>`	`description`
`java.util.List<BidsFile>`	`files`
`java.lang.String`	`name`
`java.util.List<java.util.Map<java.lang.String, java.lang.String>>`	`participants`
`java.lang.String`	`path`

Constructor Summary

Constructors
Constructor and description
`BidsDataset(java.lang.String path)` Construct a `BidsDataset` for the given root directory.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addFile(BidsFile file)` Add file to dataset
	`java.util.List<BidsFile>`	`getFilesByEntity(java.lang.String entityName, java.lang.String entityValue)` Get files by entity value
	`java.util.List<BidsFile>`	`getFilesBySuffix(java.lang.String suffix)` Get files by suffix
	`java.util.List<java.lang.String>`	`getSessions()` Get all unique sessions in dataset
	`java.util.Map<java.lang.String, java.lang.Object>`	`getStatistics()` Get dataset statistics
	`java.util.List<java.lang.String>`	`getSubjects()` Get all unique subjects in dataset
	`java.util.List<java.lang.String>`	`getSuffixes()` Get all unique suffixes in dataset
	`void`	`loadParticipants()` Load participants.tsv if it exists
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait()`

- Property Detail
  - java.util.Map<java.lang.String, java.lang.Object> description
  - java.util.List<BidsFile> files
  - java.lang.String name
  - java.util.List<java.util.Map<java.lang.String, java.lang.String>> participants
  - java.lang.String path
- Constructor Detail
  - BidsDataset(java.lang.String path)
    
    Construct a BidsDataset for the given root directory.
    The constructor validates and canonicalises the path to prevent directory-traversal attacks, then attempts to load dataset_description.json to populate name and description.
    throws:
    IllegalArgumentException if the path is null, empty, or contains a traversal attempt
    
    Parameters:
    path - absolute path to the BIDS dataset root directory
- Method Detail
  - void addFile(BidsFile file)
    
    Add file to dataset
    Parameters:
    file - BIDS file
  - java.util.List<BidsFile> getFilesByEntity(java.lang.String entityName, java.lang.String entityValue)
    
    Get files by entity value
    Parameters:
    entityName - Entity name
    entityValue - Entity value
    Returns:
    List of matching files
  - java.util.List<BidsFile> getFilesBySuffix(java.lang.String suffix)
    
    Get files by suffix
    Parameters:
    suffix - BIDS suffix (e.g., "T1w", "bold")
    Returns:
    List of matching files
  - java.util.List<java.lang.String> getSessions()
    
    Get all unique sessions in dataset
    Returns:
    List of session IDs
  - java.util.Map<java.lang.String, java.lang.Object> getStatistics()
    
    Get dataset statistics
    Returns:
    Map with statistics
  - java.util.List<java.lang.String> getSubjects()
    
    Get all unique subjects in dataset
    Returns:
    List of subject IDs
  - java.util.List<java.lang.String> getSuffixes()
    
    Get all unique suffixes in dataset
    Returns:
    List of suffixes
  - void loadParticipants()
    
    Load participants.tsv if it exists
  - @java.lang.Override
    java.lang.String toString()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class BidsDataset

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Map<java.lang.String, java.lang.Object> description

java.util.List<BidsFile> files

java.lang.String name

java.util.List<java.util.Map<java.lang.String, java.lang.String>> participants

java.lang.String path

Constructor Detail

BidsDataset(java.lang.String path)

Method Detail

void addFile(BidsFile file)

java.util.List<BidsFile> getFilesByEntity(java.lang.String entityName, java.lang.String entityValue)

java.util.List<BidsFile> getFilesBySuffix(java.lang.String suffix)

java.util.List<java.lang.String> getSessions()

java.util.Map<java.lang.String, java.lang.Object> getStatistics()

java.util.List<java.lang.String> getSubjects()

java.util.List<java.lang.String> getSuffixes()

void loadParticipants()

@java.lang.Override
java.lang.String toString()

[Groovy] Class BidsDataset

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Map<java.lang.String, java.lang.Object> description

java.util.List<BidsFile> files

java.lang.String name

java.util.List<java.util.Map<java.lang.String, java.lang.String>> participants

java.lang.String path

Constructor Detail

BidsDataset(java.lang.String path)

Method Detail

void addFile(BidsFile file)

java.util.List<BidsFile> getFilesByEntity(java.lang.String entityName, java.lang.String entityValue)

java.util.List<BidsFile> getFilesBySuffix(java.lang.String suffix)

java.util.List<java.lang.String> getSessions()

java.util.Map<java.lang.String, java.lang.Object> getStatistics()

java.util.List<java.lang.String> getSubjects()

java.util.List<java.lang.String> getSuffixes()

void loadParticipants()

@java.lang.Overridejava.lang.String toString()

@java.lang.Override
java.lang.String toString()