Package org.anchoranalysis.plugin.io.bean.summarizer

Class SummarizerAggregate<T>

Object

org.anchoranalysis.bean.AnchorBean<Summarizer<T>>

org.anchoranalysis.plugin.io.bean.summarizer.Summarizer<T>

org.anchoranalysis.plugin.io.bean.summarizer.SummarizerAggregate<T>

public class SummarizerAggregate<T>
extends Summarizer<T>

Collects summary data about a set of input files that will eventually be outputted to the user

Constructor Summary

Constructors

Constructor	Description
SummarizerAggregate()

Method Summary

Modifier and Type	Method	Description
void	add(T element)	Adds a element to the summary.
String	describe()	A string summarizing this item.
List<Summarizer<T>>	getList()
boolean	isAvoidBulletOnFirst()	Iff true no bullet is added for the very first-item in the list
boolean	requiresImageMetadata()	Whether a ImageMetadataInput is required as an input.
void	setAvoidBulletOnFirst(boolean avoidBulletOnFirst)	Iff true no bullet is added for the very first-item in the list
void	setList(List<Summarizer<T>> list)

Methods inherited from class org.anchoranalysis.plugin.io.bean.summarizer.Summarizer

addAll

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

SummarizerAggregate

public SummarizerAggregate()

Method Details

add

public void add(T element) throws org.anchoranalysis.core.exception.OperationFailedException

Description copied from class: Summarizer

Adds a element to the summary.

Specified by:

add in class Summarizer<T>

Parameters:

element - the element to add.

Throws:

org.anchoranalysis.core.exception.OperationFailedException

describe

public String describe() throws org.anchoranalysis.core.exception.OperationFailedException

Description copied from class: Summarizer

A string summarizing this item.

Specified by:

describe in class Summarizer<T>

Returns:

the description.

Throws:

org.anchoranalysis.core.exception.OperationFailedException

requiresImageMetadata

public boolean requiresImageMetadata() throws org.anchoranalysis.core.exception.OperationFailedException

Description copied from class: Summarizer

Whether a ImageMetadataInput is required as an input.

Specified by:

requiresImageMetadata in class Summarizer<T>

Returns:

true if the summarize requires ImageMetadataInput as input, or false if any input is acceptable.

Throws:

org.anchoranalysis.core.exception.OperationFailedException - if this cannot be established.

getList

public List<Summarizer<T>> getList()

setList

public void setList(List<Summarizer<T>> list)

isAvoidBulletOnFirst

public boolean isAvoidBulletOnFirst()

Iff true no bullet is added for the very first-item in the list

setAvoidBulletOnFirst

public void setAvoidBulletOnFirst(boolean avoidBulletOnFirst)

Iff true no bullet is added for the very first-item in the list