org.omg.model1.cci
Interface ReferenceFilter

All Superinterfaces:
BasicObjectFilter, ContextCapableFilter, ElementFilter, ExtentCapableFilter, FeatureFilter, RefFilter_1_0, Serializable, StructuralFeatureFilter, TypedElementFilter, ViewCapableFilter
All Known Implementing Classes:
ReferenceFilterImpl

public interface ReferenceFilter
extends StructuralFeatureFilter

A ReferenceFilter selects a set of instances of class Reference 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 forAllExposedEnd(short operator, AssociationEnd[] filterValues)
          Adds a constraint for the attribute exposedEnd to the filter.
 void forAllExposedEnd(short operator, Collection filterValues)
          Adds a constraint for the attribute exposedEnd to the filter.
 void forAllReferencedEnd(short operator, AssociationEnd[] filterValues)
          Adds a constraint for the attribute referencedEnd to the filter.
 void forAllReferencedEnd(short operator, Collection filterValues)
          Adds a constraint for the attribute referencedEnd to the filter.
 void forAllReferencedEndIsNavigable(short operator, boolean[] filterValues)
          Adds a constraint for the attribute referencedEndIsNavigable to the filter.
 void forAllReferencedEndIsNavigable(short operator, Collection filterValues)
          Adds a constraint for the attribute referencedEndIsNavigable to the filter.
 void orderByReferencedEndIsNavigable(short order)
          Specifies the sort order of all the instances that match the filter criteria.
 void thereExistsExposedEnd(short operator, AssociationEnd[] filterValues)
          Adds a constraint for the attribute exposedEnd to the filter.
 void thereExistsExposedEnd(short operator, Collection filterValues)
          Adds a constraint for the attribute exposedEnd to the filter.
 void thereExistsReferencedEnd(short operator, AssociationEnd[] filterValues)
          Adds a constraint for the attribute referencedEnd to the filter.
 void thereExistsReferencedEnd(short operator, Collection filterValues)
          Adds a constraint for the attribute referencedEnd to the filter.
 void thereExistsReferencedEndIsNavigable(short operator, boolean[] filterValues)
          Adds a constraint for the attribute referencedEndIsNavigable to the filter.
 void thereExistsReferencedEndIsNavigable(short operator, Collection filterValues)
          Adds a constraint for the attribute referencedEndIsNavigable to the filter.
 
Methods inherited from interface org.omg.model1.cci.StructuralFeatureFilter
forAllIsChangeable, forAllIsChangeable, forAllMultiplicity, forAllMultiplicity, orderByIsChangeable, orderByMultiplicity, thereExistsIsChangeable, thereExistsIsChangeable, thereExistsMultiplicity, thereExistsMultiplicity
 
Methods inherited from interface org.omg.model1.cci.FeatureFilter
forAllScope, forAllScope, forAllVisibility, forAllVisibility, orderByScope, orderByVisibility, thereExistsScope, thereExistsScope, thereExistsVisibility, thereExistsVisibility
 
Methods inherited from interface org.omg.model1.cci.TypedElementFilter
forAllType, forAllType, thereExistsType, thereExistsType
 
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

forAllExposedEnd

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

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

You can set at most one thereExistsExposedEnd or forAllExposedEnd constraint for this attribute.

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

thereExistsExposedEnd

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

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

You can set at most one thereExistsExposedEnd or forAllExposedEnd constraint for this attribute.

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

forAllExposedEnd

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

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

You can set at most one thereExistsExposedEnd or forAllExposedEnd constraint for this attribute.

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

thereExistsExposedEnd

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

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

You can set at most one thereExistsExposedEnd or forAllExposedEnd constraint for this attribute.

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

forAllReferencedEnd

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

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

You can set at most one thereExistsReferencedEnd or forAllReferencedEnd constraint for this attribute.

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

thereExistsReferencedEnd

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

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

You can set at most one thereExistsReferencedEnd or forAllReferencedEnd constraint for this attribute.

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

forAllReferencedEnd

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

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

You can set at most one thereExistsReferencedEnd or forAllReferencedEnd constraint for this attribute.

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

thereExistsReferencedEnd

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

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

You can set at most one thereExistsReferencedEnd or forAllReferencedEnd constraint for this attribute.

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

forAllReferencedEndIsNavigable

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

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

You can set at most one thereExistsReferencedEndIsNavigable or forAllReferencedEndIsNavigable constraint for this attribute.

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

thereExistsReferencedEndIsNavigable

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

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

You can set at most one thereExistsReferencedEndIsNavigable or forAllReferencedEndIsNavigable constraint for this attribute.

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

forAllReferencedEndIsNavigable

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

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

You can set at most one thereExistsReferencedEndIsNavigable or forAllReferencedEndIsNavigable constraint for this attribute.

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

thereExistsReferencedEndIsNavigable

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

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

You can set at most one thereExistsReferencedEndIsNavigable or forAllReferencedEndIsNavigable constraint for this attribute.

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

orderByReferencedEndIsNavigable

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