org.omg.model1.cci
Interface ElementFilter

All Superinterfaces:

BasicObjectFilter, ContextCapableFilter, ExtentCapableFilter, RefFilter_1_0, Serializable, ViewCapableFilter

All Known Subinterfaces:

AliasTypeFilter, AssociationEndFilter, AssociationFilter, AttributeFilter, BehaviouralFeatureFilter, ClassFilter, ClassifierFilter, CollectionTypeFilter, ConstantFilter, ConstraintFilter, DatatypeFilter, EnumerationTypeFilter, ExceptionFilter, FeatureFilter, GeneralizableElementFilter, ImportFilter, NamespaceFilter, OperationFilter, PackageFilter, ParameterFilter, PrimitiveTypeFilter, ReferenceFilter, StructuralFeatureFilter, StructureFieldFilter, StructureTypeFilter, TagFilter, TypedElementFilter

All Known Implementing Classes:

AliasTypeFilterImpl, AssociationEndFilterImpl, AssociationFilterImpl, AttributeFilterImpl, BehaviouralFeatureFilterImpl, ClassFilterImpl, ClassifierFilterImpl, CollectionTypeFilterImpl, ConstantFilterImpl, ConstraintFilterImpl, DatatypeFilterImpl, ElementFilterImpl, EnumerationTypeFilterImpl, ExceptionFilterImpl, FeatureFilterImpl, GeneralizableElementFilterImpl, ImportFilterImpl, NamespaceFilterImpl, OperationFilterImpl, PackageFilterImpl, ParameterFilterImpl, PrimitiveTypeFilterImpl, ReferenceFilterImpl, StructuralFeatureFilterImpl, StructureFieldFilterImpl, StructureTypeFilterImpl, TagFilterImpl, TypedElementFilterImpl

public interface ElementFilter
extends BasicObjectFilter

A ElementFilter selects a set of instances of class Element 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	forAllAnnotation(short operator, Collection filterValues) Adds a constraint for the attribute annotation to the filter.
void	forAllAnnotation(short operator, String[] filterValues) Adds a constraint for the attribute annotation to the filter.
void	forAllContainer(short operator, Collection filterValues) Adds a constraint for the attribute container to the filter.
void	forAllContainer(short operator, Namespace[] filterValues) Adds a constraint for the attribute container to the filter.
void	forAllName(short operator, Collection filterValues) Adds a constraint for the attribute name to the filter.
void	forAllName(short operator, String[] filterValues) Adds a constraint for the attribute name to the filter.
void	forAllQualifiedName(short operator, Collection filterValues) Adds a constraint for the attribute qualifiedName to the filter.
void	forAllQualifiedName(short operator, String[] filterValues) Adds a constraint for the attribute qualifiedName to the filter.
void	forAllStereotype(short operator, Collection filterValues) Adds a constraint for the attribute stereotype to the filter.
void	forAllStereotype(short operator, String[] filterValues) Adds a constraint for the attribute stereotype to the filter.
void	orderByAnnotation(short order) Specifies the sort order of all the instances that match the filter criteria.
void	orderByName(short order) Specifies the sort order of all the instances that match the filter criteria.
void	orderByQualifiedName(short order) Specifies the sort order of all the instances that match the filter criteria.
void	orderByStereotype(short order) Specifies the sort order of all the instances that match the filter criteria.
void	thereExistsAnnotation(short operator, Collection filterValues) Adds a constraint for the attribute annotation to the filter.
void	thereExistsAnnotation(short operator, String[] filterValues) Adds a constraint for the attribute annotation to the filter.
void	thereExistsContainer(short operator, Collection filterValues) Adds a constraint for the attribute container to the filter.
void	thereExistsContainer(short operator, Namespace[] filterValues) Adds a constraint for the attribute container to the filter.
void	thereExistsName(short operator, Collection filterValues) Adds a constraint for the attribute name to the filter.
void	thereExistsName(short operator, String[] filterValues) Adds a constraint for the attribute name to the filter.
void	thereExistsQualifiedName(short operator, Collection filterValues) Adds a constraint for the attribute qualifiedName to the filter.
void	thereExistsQualifiedName(short operator, String[] filterValues) Adds a constraint for the attribute qualifiedName to the filter.
void	thereExistsStereotype(short operator, Collection filterValues) Adds a constraint for the attribute stereotype to the filter.
void	thereExistsStereotype(short operator, String[] filterValues) Adds a constraint for the attribute stereotype to the filter.

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

forAllAnnotation

void forAllAnnotation(short operator,
                      String[] filterValues)

Adds a constraint for the attribute annotation to the filter. An instance of class Element is excluded from the result set unless its value of attribute annotation 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 thereExistsAnnotation or forAllAnnotation constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsAnnotation

void thereExistsAnnotation(short operator,
                           String[] filterValues)

Adds a constraint for the attribute annotation to the filter. An instance of class Element is excluded from the result set unless its value of attribute annotation 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 thereExistsAnnotation or forAllAnnotation constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

forAllAnnotation

void forAllAnnotation(short operator,
                      Collection filterValues)

Adds a constraint for the attribute annotation to the filter. An instance of class Element is excluded from the result set unless its value of attribute annotation 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 thereExistsAnnotation or forAllAnnotation constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsAnnotation

void thereExistsAnnotation(short operator,
                           Collection filterValues)

Adds a constraint for the attribute annotation to the filter. An instance of class Element is excluded from the result set unless its value of attribute annotation 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 thereExistsAnnotation or forAllAnnotation constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

orderByAnnotation

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

forAllContainer

void forAllContainer(short operator,
                     Namespace[] filterValues)

Adds a constraint for the attribute container to the filter. An instance of class Element is excluded from the result set unless its value of attribute container 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 thereExistsContainer or forAllContainer constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsContainer

void thereExistsContainer(short operator,
                          Namespace[] filterValues)

Adds a constraint for the attribute container to the filter. An instance of class Element is excluded from the result set unless its value of attribute container 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 thereExistsContainer or forAllContainer constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

forAllContainer

void forAllContainer(short operator,
                     Collection filterValues)

Adds a constraint for the attribute container to the filter. An instance of class Element is excluded from the result set unless its value of attribute container 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 thereExistsContainer or forAllContainer constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsContainer

void thereExistsContainer(short operator,
                          Collection filterValues)

Adds a constraint for the attribute container to the filter. An instance of class Element is excluded from the result set unless its value of attribute container 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 thereExistsContainer or forAllContainer constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

forAllName

void forAllName(short operator,
                String[] filterValues)

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

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

You can set at most one thereExistsName or forAllName constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsName

void thereExistsName(short operator,
                     String[] filterValues)

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

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

You can set at most one thereExistsName or forAllName constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

forAllName

void forAllName(short operator,
                Collection filterValues)

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

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

You can set at most one thereExistsName or forAllName constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsName

void thereExistsName(short operator,
                     Collection filterValues)

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

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

You can set at most one thereExistsName or forAllName constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

orderByName

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

forAllQualifiedName

void forAllQualifiedName(short operator,
                         String[] filterValues)

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

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

You can set at most one thereExistsQualifiedName or forAllQualifiedName constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsQualifiedName

void thereExistsQualifiedName(short operator,
                              String[] filterValues)

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

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

You can set at most one thereExistsQualifiedName or forAllQualifiedName constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

forAllQualifiedName

void forAllQualifiedName(short operator,
                         Collection filterValues)

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

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

You can set at most one thereExistsQualifiedName or forAllQualifiedName constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsQualifiedName

void thereExistsQualifiedName(short operator,
                              Collection filterValues)

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

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

You can set at most one thereExistsQualifiedName or forAllQualifiedName constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

orderByQualifiedName

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

forAllStereotype

void forAllStereotype(short operator,
                      String[] filterValues)

Adds a constraint for the attribute stereotype to the filter. An instance of class Element is excluded from the result set unless all its values of attribute stereotype satisfy the given condition.

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

You can set at most one thereExistsStereotype or forAllStereotype constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsStereotype

void thereExistsStereotype(short operator,
                           String[] filterValues)

Adds a constraint for the attribute stereotype to the filter. An instance of class Element is excluded from the result set unless at least one of its values of attribute stereotype satisfies the given condition.

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

You can set at most one thereExistsStereotype or forAllStereotype constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

forAllStereotype

void forAllStereotype(short operator,
                      Collection filterValues)

Adds a constraint for the attribute stereotype to the filter. An instance of class Element is excluded from the result set unless all its values of attribute stereotype satisfy the given condition.

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

You can set at most one thereExistsStereotype or forAllStereotype constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

thereExistsStereotype

void thereExistsStereotype(short operator,
                           Collection filterValues)

Adds a constraint for the attribute stereotype to the filter. An instance of class Element is excluded from the result set unless at least one of its values of attribute stereotype satisfies the given condition.

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

You can set at most one thereExistsStereotype or forAllStereotype constraint for this attribute.

Parameters:

operator - The operator for this filter.

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

See Also:

FilterOperators

orderByStereotype

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