fr.cnes.sirius.patrius.events.postprocessing

Class OccurrenceFilter

java.lang.Object

fr.cnes.sirius.patrius.events.postprocessing.OccurrenceFilter

All Implemented Interfaces:

PostProcessing

public final class OccurrenceFilter
extends Object
implements PostProcessing

Since:

1.1

Version:

$Id$

Author:

Julie Anton

Description :

Filter that removes or keeps only the N × k occurrences of a specific element type (code) in a given timeline.

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
OccurrenceFilter(String elementCode, int k, boolean removeAll) Constructor

Method Summary

Modifier and Type	Method and Description
void	applyTo(Timeline list)

Methods inherited from class java.lang.Object

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

Constructor Detail

OccurrenceFilter

public OccurrenceFilter(String elementCode,
                        int k,
                        boolean removeAll)

Constructor

Parameters:

elementCode - : code of the elements that has to be removed / kept

k - : occurrence sampling

removeAll - : true if the filter consists in removing the specified elements, false if the filter consisits in keeping only the specified elements.

Description :

build an instance of OccurrenceFilter from a code

Method Detail

applyTo

public void applyTo(Timeline list)

Specified by:

applyTo in interface PostProcessing

Parameters:

list - : the timeline that has to be processed