Package org.anchoranalysis.plugin.io.bean.grouper

Class IfGroupIndexRange

Object

AnchorBean<Grouper>

Grouper

IfGroupIndexRange

public class IfGroupIndexRange
extends Grouper

When a IndexRangeNegative is passed as an argument, an InputGrouper is constructed that extracts elements from a Path.

See ExtractPathElementRange.extract(java.nio.file.Path, org.anchoranalysis.core.index.range.IndexRangeNegative) for how this occurs.

Otherwise, group is called to create a Optional<InputGrouper>.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
IfGroupIndexRange()

Method Summary

Modifier and Type	Method	Description
Optional<InputGrouper>	createInputGrouper(Optional<IndexRangeNegative> groupIndexRange)	Creates an InputGrouper that can be used to derive a group-key from a particular input.
Grouper	getGroup()	Fallback to use when no group-index-range is specified.
void	setGroup(Grouper group)	Fallback to use when no group-index-range is specified.

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

IfGroupIndexRange

public IfGroupIndexRange()

Method Details

createInputGrouper

public Optional<InputGrouper> createInputGrouper(Optional<IndexRangeNegative> groupIndexRange)

Description copied from class: Grouper

Creates an InputGrouper that can be used to derive a group-key from a particular input.

Specified by:

createInputGrouper in class Grouper

Parameters:

groupIndexRange - an index-range to use for grouping, by subsetting components from each input's identifier.

Returns:

the InputGrouper, if grouping is enabled. Otherwise Optional.empty().

getGroup

public Grouper getGroup()

Fallback to use when no group-index-range is specified.

setGroup

public void setGroup(Grouper group)

Fallback to use when no group-index-range is specified.