eu.etaxonomy.cdm.api.service.description

Class DescriptionAggregationBase<T extends DescriptionAggregationBase<T,CONFIG>,CONFIG extends DescriptionAggregationConfigurationBase<T>>

java.lang.Object

eu.etaxonomy.cdm.api.service.description.DescriptionAggregationBase<T,CONFIG>

Direct Known Subclasses:

DistributionAggregation, StructuredDescriptionAggregation

public abstract class DescriptionAggregationBase<T extends DescriptionAggregationBase<T,CONFIG>,CONFIG extends DescriptionAggregationConfigurationBase<T>>
extends java.lang.Object

A common base class to run aggregation tasks on descriptive data. Usable for all types of descriptive data like structured descriptive data, ( and QuantitativeData, Distribution, Media, etc.

Since:

03.11.2019

Author:

a.mueller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	DescriptionAggregationBase.ResultHolder

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	logger

Constructor Summary

Constructors

Constructor and Description
DescriptionAggregationBase()

Method Summary

Modifier and Type	Method and Description
protected void	accumulateSingleTaxon(TaxonNode taxonNode)
protected abstract void	addAggregationResultToDescription(TaxonDescription targetDescription, DescriptionAggregationBase.ResultHolder resultHolder)
protected void	addSourcesDeduplicated(java.util.Set<DescriptionElementSource> target, java.util.Set<DescriptionElementSource> sourcesToAdd)
protected void	aggregate(java.util.List<java.lang.Integer> taxonNodeIdList, IProgressMonitor subMonitor)
protected abstract void	aggregateToParentTaxon(TaxonNode taxonNode, DescriptionAggregationBase.ResultHolder resultHolder, java.util.Set<TaxonDescription> excludedDescriptions)
protected abstract void	aggregateWithinSingleTaxon(Taxon taxon, DescriptionAggregationBase.ResultHolder resultHolder, java.util.Set<TaxonDescription> excludedDescriptions)
protected void	beginTask(java.lang.String name, int totalWork)
protected void	commitTransaction(org.springframework.transaction.TransactionStatus txStatus)
protected abstract TaxonDescription	createNewDescription(Taxon taxon)
protected abstract DescriptionAggregationBase.ResultHolder	createResultHolder()
protected abstract java.util.List<java.lang.String>	descriptionInitStrategy()
protected UpdateResult	doInvoke()
protected void	done()
protected IClassificationService	getClassificationService()
protected CONFIG	getConfig()
protected IDescriptionService	getDescriptionService()
protected IDescriptiveDataSetService	getDescriptiveDatasetService()
protected IProgressMonitor	getMonitor()
protected ICdmRepository	getRepository()
protected UpdateResult	getResult()
protected org.hibernate.Session	getSession()
protected ITaxonNodeService	getTaxonNodeService()
protected ITaxonService	getTaxonService()
protected ITermService	getTermService()
protected org.springframework.transaction.PlatformTransactionManager	getTransactionManager()
protected abstract boolean	hasDescriptionType(TaxonDescription description)
protected abstract void	initTransaction() hook for initializing object when a new transaction starts
UpdateResult	invoke(CONFIG config, ICdmRepository repository)
protected abstract java.lang.String	pluralDataType()
protected abstract void	preAggregate()
protected void	removeDescriptionIfEmpty(TaxonDescription description)
void	setBatchMinFreeHeap(long batchMinFreeHeap)
protected abstract void	setDescriptionTitle(TaxonDescription description, Taxon taxon)
protected org.springframework.transaction.TransactionStatus	startTransaction(java.lang.Boolean readOnly)
protected void	subTask(java.lang.String name)
protected java.lang.String	taxonToString(TaxonBase<?> taxon)
protected void	worked(int work)
protected void	workedAndNewTask(int work, java.lang.String newTask)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final Logger logger

Constructor Detail

DescriptionAggregationBase

public DescriptionAggregationBase()

Method Detail

invoke

public final UpdateResult invoke(CONFIG config,
                                 ICdmRepository repository)
                          throws JvmLimitsException

Throws:

JvmLimitsException

doInvoke

protected UpdateResult doInvoke()
                         throws JvmLimitsException

Throws:

JvmLimitsException

aggregate

protected void aggregate(java.util.List<java.lang.Integer> taxonNodeIdList,
                         IProgressMonitor subMonitor)
                  throws JvmLimitsException

Throws:

JvmLimitsException

accumulateSingleTaxon

protected void accumulateSingleTaxon(TaxonNode taxonNode)

removeDescriptionIfEmpty

protected void removeDescriptionIfEmpty(TaxonDescription description)

addAggregationResultToDescription

protected abstract void addAggregationResultToDescription(TaxonDescription targetDescription,
                                                          DescriptionAggregationBase.ResultHolder resultHolder)

aggregateToParentTaxon

protected abstract void aggregateToParentTaxon(TaxonNode taxonNode,
                                               DescriptionAggregationBase.ResultHolder resultHolder,
                                               java.util.Set<TaxonDescription> excludedDescriptions)

aggregateWithinSingleTaxon

protected abstract void aggregateWithinSingleTaxon(Taxon taxon,
                                                   DescriptionAggregationBase.ResultHolder resultHolder,
                                                   java.util.Set<TaxonDescription> excludedDescriptions)

createResultHolder

protected abstract DescriptionAggregationBase.ResultHolder createResultHolder()

createNewDescription

protected abstract TaxonDescription createNewDescription(Taxon taxon)

hasDescriptionType

protected abstract boolean hasDescriptionType(TaxonDescription description)

setDescriptionTitle

protected abstract void setDescriptionTitle(TaxonDescription description,
                                            Taxon taxon)

taxonToString

protected java.lang.String taxonToString(TaxonBase<?> taxon)

descriptionInitStrategy

protected abstract java.util.List<java.lang.String> descriptionInitStrategy()

preAggregate

protected abstract void preAggregate()

initTransaction

protected abstract void initTransaction()

hook for initializing object when a new transaction starts

pluralDataType

protected abstract java.lang.String pluralDataType()

addSourcesDeduplicated

protected void addSourcesDeduplicated(java.util.Set<DescriptionElementSource> target,
                                      java.util.Set<DescriptionElementSource> sourcesToAdd)

getDescriptionService

protected IDescriptionService getDescriptionService()

getDescriptiveDatasetService

protected IDescriptiveDataSetService getDescriptiveDatasetService()

getTaxonService

protected ITaxonService getTaxonService()

getTaxonNodeService

protected ITaxonNodeService getTaxonNodeService()

getTermService

protected ITermService getTermService()

getClassificationService

protected IClassificationService getClassificationService()

getTransactionManager

protected org.springframework.transaction.PlatformTransactionManager getTransactionManager()

commitTransaction

protected void commitTransaction(org.springframework.transaction.TransactionStatus txStatus)

startTransaction

protected org.springframework.transaction.TransactionStatus startTransaction(java.lang.Boolean readOnly)

getSession

protected org.hibernate.Session getSession()

getRepository

protected ICdmRepository getRepository()

getConfig

protected CONFIG getConfig()

getResult

protected UpdateResult getResult()

getMonitor

protected IProgressMonitor getMonitor()

beginTask

protected void beginTask(java.lang.String name,
                         int totalWork)

worked

protected void worked(int work)

workedAndNewTask

protected void workedAndNewTask(int work,
                                java.lang.String newTask)

subTask

protected void subTask(java.lang.String name)

done

protected void done()

setBatchMinFreeHeap

public void setBatchMinFreeHeap(long batchMinFreeHeap)