ilog.views.chart.datax.adapter.partition

Class IlvPathPartitioner

java.lang.Object

ilog.views.chart.datax.adapter.partition.IlvAbstractPartitioner<CIT>

ilog.views.chart.datax.adapter.partition.IlvColumnValuePartitioner<IlvPathClusterId>

ilog.views.chart.datax.adapter.partition.IlvPathPartitioner

All Implemented Interfaces:

IlvPartitioner<IlvPathClusterId>

public class IlvPathPartitioner
extends IlvColumnValuePartitioner<IlvPathClusterId>

This class partitions a set of objects according to the value of a model column, interpreted as a string with separators called "path". It can be used several times: the first time, it partitions according to the first component of the path, the next time according to the second component, and so on. Here a path "component" means a non-empty sequence of consecutive non-separator characters. Two adjacent components are separated by one or more separator characters.

For this partitioner, all IlvClusterIds are of type IlvPathClusterId.

Since:

JViews 7.5

See Also:

IlvPathClusterId, IlvPathPartitionerFactory

Constructor Summary

Constructors

Constructor and Description
IlvPathPartitioner(IlvObjectModelWithColumns model, IlvDataColumnInfo column, String separators, boolean ignoreLeadingSeparators, boolean ignoreTrailingSeparators, int maxDepth, boolean uniqueKeys) Creates an instance of this class.

Method Summary

Modifier and Type	Method and Description
IlvClassifier<IlvPathClusterId>	createClassifier(Object parent, IlvClassifier outerClassifier, IlvClusterId outerParentClusterId) Creates a classifier that can evaluate the children objects of the given parent object one by one.
protected String	preprocess(String value) Preprocesses a value, as returned from the model, so as to bring it into the form: word [separators] word [separators] ...

Methods inherited from class ilog.views.chart.datax.adapter.partition.IlvColumnValuePartitioner

dispose, getColumn, getColumnIndex, getModel

Methods inherited from class ilog.views.chart.datax.adapter.partition.IlvAbstractPartitioner

addPartitionerListener, fireEvent, removePartitionerListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.chart.datax.adapter.partition.IlvPartitioner

addPartitionerListener, removePartitionerListener

Constructor Detail

IlvPathPartitioner

public IlvPathPartitioner(IlvObjectModelWithColumns model,
                          IlvDataColumnInfo column,
                          String separators,
                          boolean ignoreLeadingSeparators,
                          boolean ignoreTrailingSeparators,
                          int maxDepth,
                          boolean uniqueKeys)

Creates an instance of this class.

Parameters:

model - The model being partitioned.

column - The column whose values are used for partitioning.

separators - The sequence of characters that are treated as separators.

ignoreLeadingSeparators - true if leading separators shall be ignored.

ignoreTrailingSeparators - true if trailing separators shall be ignored.

maxDepth - A limit on the depth of the clusters produced. Use Integer.MAX_VALUE for no limit.

uniqueKeys - Set to true to force clusters even for unique paths. Usually false.

Method Detail

preprocess

protected String preprocess(String value)

Preprocesses a value, as returned from the model, so as to bring it into the form: word [separators] word [separators] ...

createClassifier

public IlvClassifier<IlvPathClusterId> createClassifier(Object parent,
                                                        IlvClassifier outerClassifier,
                                                        IlvClusterId outerParentClusterId)

Creates a classifier that can evaluate the children objects of the given parent object one by one.

Parameters:

parent - The parent object whose children objects are to be grouped, or null.

outerClassifier - The last returned value of this function for the parent object or its nearest parent, or null if this is the first application of this partitioner to the objects.

outerParentClusterId - The IlvClusterId that was produced by the outerClassifier for the parent object or its nearest parent. This is null if this is the first application of this partitioner to the objects.