BinnableFiles.FileGroupExtractor (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.data.binning.BinnableFiles.FileGroupExtractor

All Implemented Interfaces:

Grouping.GroupExtractor<String>, Serializable

Enclosing class:

BinnableFiles
```
public static class BinnableFiles.FileGroupExtractor
extends Object
implements Grouping.GroupExtractor<String>, Serializable
```
Allows to extract groups either from full name or from just filename.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`m_Group`	the group to extract.
`protected boolean`	`m_OnlyName`	whether to use only the name, not the path.
`protected String`	`m_RegExp`	the regular expression.
`protected boolean`	`m_RemoveExtension`	whether to remove the extension.

Constructor Summary

Constructors
Constructor	Description
`FileGroupExtractor(boolean onlyName, boolean removeExtension, String regExp, String group)`	Initializes the extractor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String extractGroup(Binnable<String> item)
Extracts the group from the binnable object.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_OnlyName
```
protected boolean m_OnlyName
```
    whether to use only the name, not the path.
  - m_RemoveExtension
```
protected boolean m_RemoveExtension
```
    whether to remove the extension.
  - m_RegExp
```
protected String m_RegExp
```
    the regular expression.
  - m_Group
```
protected String m_Group
```
    the group to extract.
- Constructor Detail
  - FileGroupExtractor
```
public FileGroupExtractor(boolean onlyName,
                          boolean removeExtension,
                          String regExp,
                          String group)
```
    Initializes the extractor.
    
    Parameters:
    
    onlyName - whether to only consider the name, excluding the path
    
    removeExtension - whether to remove the extension
    
    regExp - the regular expression to apply to the strings
    
    group - the regexp group to extract as group
- Method Detail
  - extractGroup
```
public String extractGroup(Binnable<String> item)
```
    Extracts the group from the binnable object.
    
    Specified by:
    
    extractGroup in interface Grouping.GroupExtractor<String>
    
    Parameters:
    
    item - the item to extract the group from
    
    Returns:
    
    the extracted group