org.omg.model1.cci
Interface FeatureFilter

All Superinterfaces:
BasicObjectFilter, ContextCapableFilter, ElementFilter, ExtentCapableFilter, RefFilter_1_0, Serializable, ViewCapableFilter
All Known Subinterfaces:
AttributeFilter, BehaviouralFeatureFilter, ExceptionFilter, OperationFilter, ReferenceFilter, StructuralFeatureFilter
All Known Implementing Classes:
AttributeFilterImpl, BehaviouralFeatureFilterImpl, ExceptionFilterImpl, FeatureFilterImpl, OperationFilterImpl, ReferenceFilterImpl, StructuralFeatureFilterImpl

public interface FeatureFilter
extends ElementFilter

A FeatureFilter selects a set of instances of class Feature 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 forAllScope(short operator, Collection filterValues)
          Adds a constraint for the attribute scope to the filter.
 void forAllScope(short operator, String[] filterValues)
          Adds a constraint for the attribute scope to the filter.
 void forAllVisibility(short operator, Collection filterValues)
          Adds a constraint for the attribute visibility to the filter.
 void forAllVisibility(short operator, String[] filterValues)
          Adds a constraint for the attribute visibility to the filter.
 void orderByScope(short order)
          Specifies the sort order of all the instances that match the filter criteria.
 void orderByVisibility(short order)
          Specifies the sort order of all the instances that match the filter criteria.
 void thereExistsScope(short operator, Collection filterValues)
          Adds a constraint for the attribute scope to the filter.
 void thereExistsScope(short operator, String[] filterValues)
          Adds a constraint for the attribute scope to the filter.
 void thereExistsVisibility(short operator, Collection filterValues)
          Adds a constraint for the attribute visibility to the filter.
 void thereExistsVisibility(short operator, String[] filterValues)
          Adds a constraint for the attribute visibility to the filter.
 
Methods inherited from interface org.omg.model1.cci.ElementFilter
forAllAnnotation, forAllAnnotation, forAllContainer, forAllContainer, forAllName, forAllName, forAllQualifiedName, forAllQualifiedName, forAllStereotype, forAllStereotype, orderByAnnotation, orderByName, orderByQualifiedName, orderByStereotype, thereExistsAnnotation, thereExistsAnnotation, thereExistsContainer, thereExistsContainer, thereExistsName, thereExistsName, thereExistsQualifiedName, thereExistsQualifiedName, thereExistsStereotype, thereExistsStereotype
 
Methods inherited from interface org.openmdx.base.cci.BasicObjectFilter
forAllCreatedAt, forAllCreatedAt, forAllCreatedBy, forAllCreatedBy, forAllModifiedAt, forAllModifiedAt, forAllModifiedBy, forAllModifiedBy, orderByCreatedAt, orderByCreatedBy, orderByModifiedAt, orderByModifiedBy, thereExistsCreatedAt, thereExistsCreatedAt, thereExistsCreatedBy, thereExistsCreatedBy, thereExistsModifiedAt, thereExistsModifiedAt, thereExistsModifiedBy, thereExistsModifiedBy
 
Methods inherited from interface org.openmdx.base.cci.ContextCapableFilter
forAllContext, forAllContext, thereExistsContext, thereExistsContext
 
Methods inherited from interface org.openmdx.base.cci.ExtentCapableFilter
forAllIdentity, forAllIdentity, orderByIdentity, thereExistsIdentity, thereExistsIdentity
 
Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefFilter_1_0
clear, refAddValue, refAddValue, refAddValue, refGetAttributeSpecifiers, refGetFilterProperties
 

Method Detail

forAllScope

void forAllScope(short operator,
                 String[] filterValues)
Adds a constraint for the attribute scope to the filter. An instance of class Feature is excluded from the result set unless its value of attribute scope satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllScope and thereExistsScope for the same arguments.

You can set at most one thereExistsScope or forAllScope constraint for this attribute.

Parameters:
operator - The operator for this filter.
filterValues - The values you want the attribute scope to be compared to.
See Also:
FilterOperators

thereExistsScope

void thereExistsScope(short operator,
                      String[] filterValues)
Adds a constraint for the attribute scope to the filter. An instance of class Feature is excluded from the result set unless its value of attribute scope satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllScope and thereExistsScope for the same arguments.

You can set at most one thereExistsScope or forAllScope constraint for this attribute.

Parameters:
operator - The operator for this filter.
filterValues - The values you want the attribute scope to be compared to.
See Also:
FilterOperators

forAllScope

void forAllScope(short operator,
                 Collection filterValues)
Adds a constraint for the attribute scope to the filter. An instance of class Feature is excluded from the result set unless its value of attribute scope satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllScope and thereExistsScope for the same arguments.

You can set at most one thereExistsScope or forAllScope constraint for this attribute.

Parameters:
operator - The operator for this filter.
filterValues - The values you want the attribute scope to be compared to.
See Also:
FilterOperators

thereExistsScope

void thereExistsScope(short operator,
                      Collection filterValues)
Adds a constraint for the attribute scope to the filter. An instance of class Feature is excluded from the result set unless its value of attribute scope satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllScope and thereExistsScope for the same arguments.

You can set at most one thereExistsScope or forAllScope constraint for this attribute.

Parameters:
operator - The operator for this filter.
filterValues - The values you want the attribute scope to be compared to.
See Also:
FilterOperators

orderByScope

void orderByScope(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

forAllVisibility

void forAllVisibility(short operator,
                      String[] filterValues)
Adds a constraint for the attribute visibility to the filter. An instance of class Feature is excluded from the result set unless its value of attribute visibility satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllVisibility and thereExistsVisibility for the same arguments.

You can set at most one thereExistsVisibility or forAllVisibility constraint for this attribute.

Parameters:
operator - The operator for this filter.
filterValues - The values you want the attribute visibility to be compared to.
See Also:
FilterOperators

thereExistsVisibility

void thereExistsVisibility(short operator,
                           String[] filterValues)
Adds a constraint for the attribute visibility to the filter. An instance of class Feature is excluded from the result set unless its value of attribute visibility satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllVisibility and thereExistsVisibility for the same arguments.

You can set at most one thereExistsVisibility or forAllVisibility constraint for this attribute.

Parameters:
operator - The operator for this filter.
filterValues - The values you want the attribute visibility to be compared to.
See Also:
FilterOperators

forAllVisibility

void forAllVisibility(short operator,
                      Collection filterValues)
Adds a constraint for the attribute visibility to the filter. An instance of class Feature is excluded from the result set unless its value of attribute visibility satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllVisibility and thereExistsVisibility for the same arguments.

You can set at most one thereExistsVisibility or forAllVisibility constraint for this attribute.

Parameters:
operator - The operator for this filter.
filterValues - The values you want the attribute visibility to be compared to.
See Also:
FilterOperators

thereExistsVisibility

void thereExistsVisibility(short operator,
                           Collection filterValues)
Adds a constraint for the attribute visibility to the filter. An instance of class Feature is excluded from the result set unless its value of attribute visibility satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllVisibility and thereExistsVisibility for the same arguments.

You can set at most one thereExistsVisibility or forAllVisibility constraint for this attribute.

Parameters:
operator - The operator for this filter.
filterValues - The values you want the attribute visibility to be compared to.
See Also:
FilterOperators

orderByVisibility

void orderByVisibility(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


This software is published under the BSD license. Copyright © 2003-2008, OMEX AG, Switzerland, All rights reserved. Use is subject to license terms.