Package org.anchoranalysis.io.input.bean.grouper

Class Grouper

Object

org.anchoranalysis.bean.AnchorBean<Grouper>

org.anchoranalysis.io.input.bean.grouper.Grouper

Direct Known Subclasses:

FromDerivePath, WithoutGrouping

public abstract class Grouper
extends AnchorBean<Grouper>

Determines how partition inputs into groups.

This is typically based upon the input-identifiers.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
Grouper()

Method Summary

Modifier and Type	Method	Description
abstract Optional<InputGrouper>	createInputGrouper(Optional<IndexRangeNegative> groupIndexRange)	Creates an InputGrouper that can be used to derive a group-key from a particular input.

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

Grouper

public Grouper()

Method Details

createInputGrouper

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

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

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