MetadataOptions - Control Group Files Granularity #2458
Conversation
Add options to MetadataOptions enabling control of the granularity and depth of group files.
|
Main question for me is how this gets used in practice (in readers, and as an API consumer). Does the value of I do also kind of wonder if the enum is necessary, since if I understand |
|
As for how this gets used, it really relies on readers to be aware of the options set and implement them, otherwise from API consumer point of view it wont be having any effect as it is. I had imagined that readers would only use the options in cases were isGroupFiles is true. For your example of ScanR, my thinking was that currently the default is set to represent the top level directory, setting the options to RECURSIVE would represent the user wishes to search all child directories, and using LIMITED_DEPTH with maxDepth of 1 would represent searching in child folders only. So either of the latter 2 options would work with the last being the most efficient if you know you are only searching to a certain depth. I used enum largely for readability, it certainly could be reduced to just using maxDepth value if that simplifies things. |
|
Conflicting PR. Removed from build BIOFORMATS-DEV-merge-push#508. See the console output for more details.
|
|
Conflicting PR. Removed from build BIOFORMATS-DEV-merge-push#509. See the console output for more details.
|
|
Conflicting PR. Removed from build BIOFORMATS-DEV-merge-push#510. See the console output for more details.
|
|
Conflicting PR. Removed from build BIOFORMATS-DEV-merge-push#511. See the console output for more details.
|
|
Conflicting PR. Removed from build BIOFORMATS-DEV-merge-push#512. See the console output for more details.
|
Adding new MetadataOptions which can be used to control the granularity of group files.
The following options are available:
The new MetadataGroupFilesOptions contains an enum GroupFilesGranularity and a maxDepth value to represent these options. The getMaxDepth will return 0 if the granularity is set to TOP_LEVEL and Intger. MAX_VALUE if the granularity is set to RECURSIVE.
As these options are not yet implemented in any individual readers there is no specific testing required, only to confirm that the proposed options provide the desired functionality for future usage.