org.omg.model1.cci
Interface CollectionTypeFilter

All Superinterfaces:
BasicObjectFilter, ClassifierFilter, ContextCapableFilter, DatatypeFilter, ElementFilter, ExtentCapableFilter, GeneralizableElementFilter, NamespaceFilter, RefFilter_1_0, Serializable, TypedElementFilter, ViewCapableFilter
All Known Implementing Classes:
CollectionTypeFilterImpl

public interface CollectionTypeFilter
extends DatatypeFilter, TypedElementFilter

A CollectionTypeFilter selects a set of instances of class CollectionType 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 forAllMultiplicity(short operator, Collection filterValues)
          Adds a constraint for the attribute multiplicity to the filter.
 void forAllMultiplicity(short operator, String[] filterValues)
          Adds a constraint for the attribute multiplicity to the filter.
 void orderByMultiplicity(short order)
          Specifies the sort order of all the instances that match the filter criteria.
 void thereExistsMultiplicity(short operator, Collection filterValues)
          Adds a constraint for the attribute multiplicity to the filter.
 void thereExistsMultiplicity(short operator, String[] filterValues)
          Adds a constraint for the attribute multiplicity to the filter.
 
Methods inherited from interface org.omg.model1.cci.ClassifierFilter
forAllCompositeReference, forAllCompositeReference, thereExistsCompositeReference, thereExistsCompositeReference
 
Methods inherited from interface org.omg.model1.cci.GeneralizableElementFilter
forAllAllSubtype, forAllAllSubtype, forAllAllSupertype, forAllAllSupertype, forAllFeature, forAllFeature, forAllIsAbstract, forAllIsAbstract, forAllSubtype, forAllSubtype, forAllSupertype, forAllSupertype, forAllVisibility, forAllVisibility, orderByIsAbstract, orderByVisibility, thereExistsAllSubtype, thereExistsAllSubtype, thereExistsAllSupertype, thereExistsAllSupertype, thereExistsFeature, thereExistsFeature, thereExistsIsAbstract, thereExistsIsAbstract, thereExistsSubtype, thereExistsSubtype, thereExistsSupertype, thereExistsSupertype, thereExistsVisibility, thereExistsVisibility
 
Methods inherited from interface org.omg.model1.cci.NamespaceFilter
forAllContent, forAllContent, thereExistsContent, thereExistsContent
 
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
 
Methods inherited from interface org.omg.model1.cci.TypedElementFilter
forAllType, forAllType, thereExistsType, thereExistsType
 

Method Detail

forAllMultiplicity

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

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

You can set at most one thereExistsMultiplicity or forAllMultiplicity constraint for this attribute.

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

thereExistsMultiplicity

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

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

You can set at most one thereExistsMultiplicity or forAllMultiplicity constraint for this attribute.

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

forAllMultiplicity

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

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

You can set at most one thereExistsMultiplicity or forAllMultiplicity constraint for this attribute.

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

thereExistsMultiplicity

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

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

You can set at most one thereExistsMultiplicity or forAllMultiplicity constraint for this attribute.

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

orderByMultiplicity

void orderByMultiplicity(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.