org.openmdx.base.cci
Interface SegmentFilter

All Superinterfaces:

ContextCapableFilter, RefFilter_1_0, Serializable, ViewCapableFilter

All Known Subinterfaces:

SegmentFilter, SegmentFilter, SegmentFilter

All Known Implementing Classes:

SegmentFilterImpl, SegmentFilterImpl, SegmentFilterImpl, SegmentFilterImpl

public interface SegmentFilter
extends ContextCapableFilter, ViewCapableFilter

A SegmentFilter selects a set of instances of class Segment based on conditions to be met by their attributes. For each attribute there can be set at most one constraint using either its thereExists or forAll clause. An instance must meet all constraints to be member of this set.

Method Summary

void	forAllDescription(short operator, Collection filterValues) Adds a constraint for the attribute description to the filter.
void	forAllDescription(short operator, String[] filterValues) Adds a constraint for the attribute description to the filter.
void	orderByDescription(short order) Specifies the sort order of all the instances that match the filter criteria.
void	thereExistsDescription(short operator, Collection filterValues) Adds a constraint for the attribute description to the filter.
void	thereExistsDescription(short operator, String[] filterValues) Adds a constraint for the attribute description to the filter.

Methods inherited from interface org.openmdx.base.cci.ContextCapableFilter

forAllContext, forAllContext, thereExistsContext, thereExistsContext

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefFilter_1_0

clear, refAddValue, refAddValue, refAddValue, refGetAttributeSpecifiers, refGetFilterProperties

Method Detail

forAllDescription

void forAllDescription(short operator,
                       String[] filterValues)

Adds a constraint for the attribute description to the filter. An instance of class Segment is excluded from the result set unless its value of attribute description satisfies the given condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the filter condition is met!

You can set at most one thereExistsDescription or forAllDescription constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute description to be compared to.

See Also:

FilterOperators

thereExistsDescription

void thereExistsDescription(short operator,
                            String[] filterValues)

Adds a constraint for the attribute description to the filter. An instance of class Segment is excluded from the result set unless its value of attribute description satisfies the given condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the filter condition is not met!

You can set at most one thereExistsDescription or forAllDescription constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute description to be compared to.

See Also:

FilterOperators

forAllDescription

void forAllDescription(short operator,
                       Collection filterValues)

Adds a constraint for the attribute description to the filter. An instance of class Segment is excluded from the result set unless its value of attribute description satisfies the given condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the filter condition is met!

You can set at most one thereExistsDescription or forAllDescription constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute description to be compared to.

See Also:

FilterOperators

thereExistsDescription

void thereExistsDescription(short operator,
                            Collection filterValues)

Adds a constraint for the attribute description to the filter. An instance of class Segment is excluded from the result set unless its value of attribute description satisfies the given condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the filter condition is not met!

You can set at most one thereExistsDescription or forAllDescription constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute description to be compared to.

See Also:

FilterOperators

orderByDescription

void orderByDescription(short order)

Specifies the sort order of all the instances that match the filter criteria.

Parameters:

order - The sort order for this filter.

See Also:

Directions