BidsChannelData (nf-bids 0.3.0 API)

nfneuro.model.BidsChannelData

```
@groovy.transform.CompileStatic
class BidsChannelData
extends java.lang.Object
```
Container for BIDS channel data assembled by the set handlers.
Accumulates per-suffix data maps, associated file paths, and loop-over entity values during the grouping phase. toChannelTuple(List) serialises the container into the [groupingKey, enrichedData] tuple format consumed by nfneuro.plugin.channel.BidsHandler before flattening.

The flat output emitted by Channel.fromBIDS() is built from this structure by converting string paths to java.nio.file.Path objects and placing suffix data maps at the top level alongside a meta map of entity values.

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`bidsParentDir`
`java.util.Map<java.lang.String, java.lang.Object>`	`data`
`java.util.Map<java.lang.String, java.lang.String>`	`entities`
`java.util.List<java.lang.String>`	`filePaths`

Constructor Summary

Constructors
Constructor and description
`BidsChannelData()` Construct an empty `BidsChannelData` container.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addEntity(java.lang.String entityName, java.lang.String entityValue)` Add entity value
	`void`	`addFilePath(java.lang.String filePath)` Add file path
	`void`	`addFilePaths(java.util.List<java.lang.String> paths)` Add multiple file paths
	`void`	`addSuffixData(java.lang.String suffix, java.lang.Object suffixData)` Add suffix data
	`boolean`	`equals(java.lang.Object obj)`
	`java.lang.String`	`getEntity(java.lang.String entityName)` Get entity value
	`java.lang.Object`	`getSuffixData(java.lang.String suffix)` Get suffix data
	`java.util.List<java.lang.String>`	`getSuffixes()` Get all suffixes in this channel data
	`boolean`	`hasEntity(java.lang.String entityName)` Check if entity exists
	`boolean`	`hasSuffix(java.lang.String suffix)` Check if suffix exists in data
	`int`	`hashCode()`
	`boolean`	`isEmpty()` Check if channel data is empty
	`boolean`	`isValid()` Validate that channel data has required content
	`java.lang.Object`	`toChannelTuple(java.util.List<java.lang.String> loopOverEntities)` Convert to channel tuple format
	`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.lang.String bidsParentDir
  - java.util.Map<java.lang.String, java.lang.Object> data
  - java.util.Map<java.lang.String, java.lang.String> entities
  - java.util.List<java.lang.String> filePaths
- Constructor Detail
  - BidsChannelData()
    
    Construct an empty BidsChannelData container.
- Method Detail
  - void addEntity(java.lang.String entityName, java.lang.String entityValue)
    
    Add entity value
    Parameters:
    entityName - Entity name
    entityValue - Entity value
  - void addFilePath(java.lang.String filePath)
    
    Add file path
    Parameters:
    filePath - File path to add
  - void addFilePaths(java.util.List<java.lang.String> paths)
    
    Add multiple file paths
    Parameters:
    paths - List of file paths
  - void addSuffixData(java.lang.String suffix, java.lang.Object suffixData)
    
    Add suffix data
    Parameters:
    suffix - BIDS suffix
    suffixData - Data for this suffix (can be String path, Map, or List)
  - @java.lang.Override
    boolean equals(java.lang.Object obj)
  - java.lang.String getEntity(java.lang.String entityName)
    
    Get entity value
    Parameters:
    entityName - Entity name
    Returns:
    Entity value or "NA"
  - java.lang.Object getSuffixData(java.lang.String suffix)
    
    Get suffix data
    Parameters:
    suffix - BIDS suffix
    Returns:
    Suffix data or null
  - java.util.List<java.lang.String> getSuffixes()
    
    Get all suffixes in this channel data
    Returns:
    List of suffix names
  - boolean hasEntity(java.lang.String entityName)
    
    Check if entity exists
    Parameters:
    entityName - Entity name
    Returns:
    true if entity exists and is not "NA"
  - boolean hasSuffix(java.lang.String suffix)
    
    Check if suffix exists in data
    Parameters:
    suffix - BIDS suffix
    Returns:
    true if suffix data exists
  - @java.lang.Override
    int hashCode()
  - boolean isEmpty()
    
    Check if channel data is empty
    Returns:
    true if no data
  - boolean isValid()
    
    Validate that channel data has required content
    Returns:
    true if valid (has data and entities)
  - java.lang.Object toChannelTuple(java.util.List<java.lang.String> loopOverEntities)
    
    Convert to channel tuple format
    Parameters:
    loopOverEntities - Entities to use for grouping key (also determines which entities appear in enriched data)
    Returns:
    Tuple [groupingKey, enrichedData]
  - @java.lang.Override
    java.lang.String toString()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class BidsChannelData

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String bidsParentDir

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

java.util.Map<java.lang.String, java.lang.String> entities

java.util.List<java.lang.String> filePaths

Constructor Detail

BidsChannelData()

Method Detail

void addEntity(java.lang.String entityName, java.lang.String entityValue)

void addFilePath(java.lang.String filePath)

void addFilePaths(java.util.List<java.lang.String> paths)

void addSuffixData(java.lang.String suffix, java.lang.Object suffixData)

@java.lang.Override
boolean equals(java.lang.Object obj)

java.lang.String getEntity(java.lang.String entityName)

java.lang.Object getSuffixData(java.lang.String suffix)

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

boolean hasEntity(java.lang.String entityName)

boolean hasSuffix(java.lang.String suffix)

@java.lang.Override
int hashCode()

boolean isEmpty()

boolean isValid()

java.lang.Object toChannelTuple(java.util.List<java.lang.String> loopOverEntities)

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

[Groovy] Class BidsChannelData

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String bidsParentDir

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

java.util.Map<java.lang.String, java.lang.String> entities

java.util.List<java.lang.String> filePaths

Constructor Detail

BidsChannelData()

Method Detail

void addEntity(java.lang.String entityName, java.lang.String entityValue)

void addFilePath(java.lang.String filePath)

void addFilePaths(java.util.List<java.lang.String> paths)

void addSuffixData(java.lang.String suffix, java.lang.Object suffixData)

@java.lang.Overrideboolean equals(java.lang.Object obj)

java.lang.String getEntity(java.lang.String entityName)

java.lang.Object getSuffixData(java.lang.String suffix)

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

boolean hasEntity(java.lang.String entityName)

boolean hasSuffix(java.lang.String suffix)

@java.lang.Overrideint hashCode()

boolean isEmpty()

boolean isValid()

java.lang.Object toChannelTuple(java.util.List<java.lang.String> loopOverEntities)

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

@java.lang.Override
boolean equals(java.lang.Object obj)

@java.lang.Override
int hashCode()

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