BidsFile (nf-bids 0.3.0 API)

nfneuro.model.BidsFile

```
@groovy.transform.CompileStatic
class BidsFile
extends java.lang.Object
```
Represents a single file entry in a BIDS dataset.
Stores the file path, BIDS suffix (e.g. "T1w", "bold"), the list of BidsEntity key–value pairs parsed from the filename, optional JSON sidecar and other associated file paths, and file-system metadata (size, modification time) loaded on demand.

Instances are created by nfneuro.plugin.util.BidsCsvParser from the TSV output of libBIDSsh_parse_bids_to_table. The isPrimaryFile() and getBasename() helpers drive grouping logic in the set handlers.

Field Summary

Fields
Modifiers	Name	Description
`static java.util.List<java.lang.String>`	`PRIMARY_EXTENSIONS`
`static java.util.List<java.lang.String>`	`TYPE_ALLOWING_PARTS`
`static java.util.Map<java.lang.String, java.lang.String>`	`VALID_EXTENSIONS`

Properties Summary

Properties
Type	Name and description
`java.util.List<java.lang.String>`	`associatedFiles`
`java.util.List<BidsEntity>`	`entities`
`java.lang.Long`	`fileSize`
`java.lang.String`	`jsonSidecar`
`java.lang.Long`	`lastModified`
`java.util.Map<java.lang.String, java.lang.Object>`	`metadata`
`java.lang.String`	`path`
`java.lang.String`	`suffix`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addAssociatedFile(java.lang.String filePath)` Add associated file (JSON sidecar, etc.)
	`void`	`addEntity(java.lang.String name, java.lang.String value)` Add entity to file
	`void`	`addEntity(BidsEntity entity)`
	`void`	`addMetadata(java.lang.String key, java.lang.Object value)` Add metadata to file
	`boolean`	`equals(java.lang.Object obj)`
	`java.lang.String`	`getBasename()` Get the base name of a file without extension
	`java.lang.String`	`getBasename(java.util.List<java.lang.String> excludeEntities)` Get the base name of a file without extension
	`BidsEntity`	`getEntity(java.lang.String name)`
	`java.lang.String`	`getEntityValue(java.lang.String entityName)` Get entity value by name
	`java.lang.String`	`getExtensionType()` Get extension type for categorization
	`java.lang.String`	`getFilename()` Get filename without path
	`java.lang.Object`	`getMetadata(java.lang.String key)` Get metadata value by key
	`java.lang.String`	`getParentDir()` Get parent directory
	`java.lang.String`	`getSidecarPath()` Get sidecar path (alias for jsonSidecar for compatibility)
	`java.lang.String`	`getType()`
	`boolean`	`hasEntity(java.lang.String entityName)` Check if entity exists
	`int`	`hashCode()`
	`boolean`	`isPrimaryFile()`
	`void`	`loadFileMetadata()` Load file metadata (size, modification time)
	`java.lang.String`	`relativeTo(java.lang.String basePath)` Convert absolute path to relative path from base path
	`java.lang.String`	`toString()`
	`static boolean`	`typeAllowsParts(java.lang.String type)`

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()`

- Field Detail
  - public static final java.util.List<java.lang.String> PRIMARY_EXTENSIONS
  - public static final java.util.List<java.lang.String> TYPE_ALLOWING_PARTS
  - public static final java.util.Map<java.lang.String, java.lang.String> VALID_EXTENSIONS
- Property Detail
  - java.util.List<java.lang.String> associatedFiles
  - java.util.List<BidsEntity> entities
  - java.lang.Long fileSize
  - java.lang.String jsonSidecar
  - java.lang.Long lastModified
  - java.util.Map<java.lang.String, java.lang.Object> metadata
  - java.lang.String path
  - java.lang.String suffix
- Constructor Detail
  - BidsFile(java.lang.String path)
    
    Construct a BidsFile for the given path.
    The BIDS suffix is extracted automatically from the filename if possible.
    throws:
    IllegalArgumentException if path is null or empty
    
    Parameters:
    path - absolute or relative path to the BIDS file
- Method Detail
  - void addAssociatedFile(java.lang.String filePath)
    
    Add associated file (JSON sidecar, etc.)
    Parameters:
    filePath - Path to associated file
  - void addEntity(java.lang.String name, java.lang.String value)
    
    Add entity to file
    Parameters:
    name - Entity name
    value - Entity value
  - void addEntity(BidsEntity entity)
  - void addMetadata(java.lang.String key, java.lang.Object value)
    
    Add metadata to file
    Parameters:
    key - Metadata key
    value - Metadata value
  - @java.lang.Override
    boolean equals(java.lang.Object obj)
  - java.lang.String getBasename()
    
    Get the base name of a file without extension
  - java.lang.String getBasename(java.util.List<java.lang.String> excludeEntities)
    
    Get the base name of a file without extension
  - BidsEntity getEntity(java.lang.String name)
  - java.lang.String getEntityValue(java.lang.String entityName)
    
    Get entity value by name
    Parameters:
    entityName - Entity name (e.g., "sub", "ses")
    Returns:
    Entity value or "NA" if not present
  - java.lang.String getExtensionType()
    
    Get extension type for categorization
  - java.lang.String getFilename()
    
    Get filename without path
    Returns:
    Filename
  - java.lang.Object getMetadata(java.lang.String key)
    
    Get metadata value by key
    Parameters:
    key - Metadata key
    Returns:
    Metadata value or null
  - java.lang.String getParentDir()
    
    Get parent directory
    Returns:
    Parent directory path
  - java.lang.String getSidecarPath()
    
    Get sidecar path (alias for jsonSidecar for compatibility)
    Returns:
    JSON sidecar path or null
  - java.lang.String getType()
  - boolean hasEntity(java.lang.String entityName)
    
    Check if entity exists
    Parameters:
    entityName - Entity name
    Returns:
    true if entity is present and not "NA"
  - @java.lang.Override
    int hashCode()
  - boolean isPrimaryFile()
  - void loadFileMetadata()
    
    Load file metadata (size, modification time)
  - java.lang.String relativeTo(java.lang.String basePath)
    
    Convert absolute path to relative path from base path
  - @java.lang.Override
    java.lang.String toString()
  - static boolean typeAllowsParts(java.lang.String type)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class BidsFile

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.util.List<java.lang.String> PRIMARY_EXTENSIONS

public static final java.util.List<java.lang.String> TYPE_ALLOWING_PARTS

public static final java.util.Map<java.lang.String, java.lang.String> VALID_EXTENSIONS

Property Detail

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

java.util.List<BidsEntity> entities

java.lang.Long fileSize

java.lang.String jsonSidecar

java.lang.Long lastModified

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

java.lang.String path

java.lang.String suffix

Constructor Detail

BidsFile(java.lang.String path)

Method Detail

void addAssociatedFile(java.lang.String filePath)

void addEntity(java.lang.String name, java.lang.String value)

void addEntity(BidsEntity entity)

void addMetadata(java.lang.String key, java.lang.Object value)

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

java.lang.String getBasename()

java.lang.String getBasename(java.util.List<java.lang.String> excludeEntities)

BidsEntity getEntity(java.lang.String name)

java.lang.String getEntityValue(java.lang.String entityName)

java.lang.String getExtensionType()

java.lang.String getFilename()

java.lang.Object getMetadata(java.lang.String key)

java.lang.String getParentDir()

java.lang.String getSidecarPath()

java.lang.String getType()

boolean hasEntity(java.lang.String entityName)

@java.lang.Overrideint hashCode()

boolean isPrimaryFile()

void loadFileMetadata()

java.lang.String relativeTo(java.lang.String basePath)

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

static boolean typeAllowsParts(java.lang.String type)

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

@java.lang.Override
int hashCode()

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