com.hp.ucmdb.api.view.foldingdefinition

Interface GroupByAttributeSyntheticFDN

All Superinterfaces:

FoldingDefinitionNode, SupportsClientProperties<FoldingDefinitionNode>, SupportsInvisibility<FoldingDefinitionNode>, SyntheticFDN

public interface GroupByAttributeSyntheticFDN
extends SyntheticFDN

This node creates a different result node for each permutation on a specific attribute value (or regular expression of) of each of the defining QueryBasedFDN result nodes.

If a regular expression is defined (not empty), the node attribute value will be fed to the regular and the capture group with the given id will be used to distinguish result nodes. The regular expression will be evaluated using Java Pattern default rules. If the capture group id doesn't exist in the result, the transformation result will be empty. Note: Only the first match will be used for any regular expression.

If the synthetic has no label the attribute value will be the label. If the synthetic node has a label with {0} in it, the attribute value will replace the {0} using MessageFormat rules. In any other case the label will not be touched.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
String	attributeName() The attribute to group by.
int	regularExpressionCaptureGroupIndex() The capture group index of the regular expression.
String	regularExpressionFilter() The regular expression used to transform the attribute value.
GroupByAttributeSyntheticFDN	withAppearEvenIfEmptyFlag(boolean appearEvenIfEmpty) overriden to provide type safety.
GroupByAttributeSyntheticFDN	withAttributeName(String attributeName) The attribute to group by.
GroupByAttributeSyntheticFDN	withDefiningQueryBasedFDNName(String definingQueryBasedFDNName) overriden to provide type safety.
GroupByAttributeSyntheticFDN	withLabel(String label) overriden to provide type safety.
GroupByAttributeSyntheticFDN	withRegularExpressionFilter(String regularExpression, int regularExpressionCaptureGroupIndex) Sets a regular expression and capture group for value transformation before grouping.

Methods inherited from interface com.hp.ucmdb.api.view.foldingdefinition.SyntheticFDN

addChild, addChild, appearEvenIfEmpty, definingQueryBasedFDNName, label

Methods inherited from interface com.hp.ucmdb.api.view.foldingdefinition.FoldingDefinitionNode

addSortingRule, addSortingRule, addViewAttribute, asQueryNodeBasedFDN, asSyntheticNode, children, definition, name, parent, root, sortingRules, viewAttributes

Methods inherited from interface com.hp.ucmdb.api.util.SupportsClientProperties

clientProperties, clientProperty, usedNamespaces, withClientProperty

Methods inherited from interface com.hp.ucmdb.api.topology.SupportsInvisibility

invisible, isInvisible

Method Detail

attributeName

String attributeName()

The attribute to group by.

withAttributeName

GroupByAttributeSyntheticFDN withAttributeName(String attributeName)

The attribute to group by. May not be null.

Returns:

this GroupByAttributeSyntheticFDN.

regularExpressionCaptureGroupIndex

int regularExpressionCaptureGroupIndex()

The capture group index of the regular expression. If no regular expression is defined, will return -1.

regularExpressionFilter

String regularExpressionFilter()

The regular expression used to transform the attribute value. If none was defined, will return an empty string.

withRegularExpressionFilter

GroupByAttributeSyntheticFDN withRegularExpressionFilter(String regularExpression,
                                                         int regularExpressionCaptureGroupIndex)

Sets a regular expression and capture group for value transformation before grouping. The regular expression may not be null, the value must be non-negative number.

Returns:

this GroupByAttributeSyntheticFDN.

withLabel

GroupByAttributeSyntheticFDN withLabel(String label)

overriden to provide type safety.

Specified by:

withLabel in interface SyntheticFDN

Returns:

this SyntheticFDN.

See Also:

SyntheticFDN.withLabel(String)

withAppearEvenIfEmptyFlag

GroupByAttributeSyntheticFDN withAppearEvenIfEmptyFlag(boolean appearEvenIfEmpty)

overriden to provide type safety.

Specified by:

withAppearEvenIfEmptyFlag in interface SyntheticFDN

Returns:

this SyntheticFDN.

See Also:

SyntheticFDN.withAppearEvenIfEmptyFlag(boolean)

withDefiningQueryBasedFDNName

GroupByAttributeSyntheticFDN withDefiningQueryBasedFDNName(String definingQueryBasedFDNName)

overriden to provide type safety.

Specified by:

withDefiningQueryBasedFDNName in interface SyntheticFDN

See Also:

SyntheticFDN.withDefiningQueryBasedFDNName(String)