org.openmdx.base.accessor.jmi.cci
Interface RefFilter_1_0

All Superinterfaces:

Serializable

All Known Subinterfaces:

AliasTypeFilter, AssociationEndFilter, AssociationFilter, AttributeFilter, AuditableFilter, AuthorityFilter, BasicObjectFilter, BasicStateFilter, BehaviouralFeatureFilter, BooleanPropertyFilter, BooleanPropertyFilter, ClassFilter, ClassifierExternalizeClassifierParamsFilter, ClassifierExternalizeResultFilter, ClassifierFilter, CollectionTypeFilter, ComponentFilter, ConfigurationFilter, ConnectionFilter, ConstantFilter, ConstraintFilter, ContextCapableFilter, ContextFilter, DatabaseConnectorFilter, DatabaseFilter, DatabaseResourceReferenceFilter, DataproviderBooleanPropertyFilter, DataproviderConnectorFilter, DataproviderFilter, DataproviderIntegerPropertyFilter, DataproviderPropertyFilter, DataproviderResourceFilter, DataproviderResourceReferenceFilter, DataproviderStringPropertyFilter, DataproviderTypeBooleanPropertyFilter, DataproviderTypeFilter, DataproviderTypeIntegerPropertyFilter, DataproviderTypePropertyFilter, DataproviderTypeStringPropertyFilter, DatastoreFilter, DatatypeFilter, DateStateExcludingEndFilter, DateStateFilter, DateTimeStateFilter, DecimalPropertyFilter, DecimalPropertyFilter, DeploymentUnitFilter, DomainFilter, DomainFilter, ElementFilter, EnumerationTypeFilter, ExceptionFilter, ExtentCapableFilter, FeatureFilter, FilterFilter, GeneralizableElementFilter, GenericResourceReferenceFilter, GetStreamResultFilter, HistoryStateFilter, HttpUrlConnectorFilter, ImportFilter, InboundCommunicationFilter, IndexFilter, InstanceFilter, IntegerPropertyFilter, IntegerPropertyFilter, InvolvedFilter, LockFilter, ModuleFilter, NamespaceFilter, NamespaceFilter, NamespaceFindElementsByTypeParamsFilter, NamespaceFindElementsByTypeResultFilter, NamespaceLookupElementParamsFilter, NamespaceLookupElementResultFilter, NamespaceResolveQualifiedNameParamsFilter, NamespaceResolveQualifiedNameResultFilter, OperationFilter, OptimisticLockFilter, OutboundCommunicationFilter, PackageExternalizeParamsFilter, PackageExternalizeResultFilter, PackageFilter, ParameterFilter, PreferencesFilter, PrimitiveTypeFilter, PropertyFilter, PropertyFilter, PropertySetFilter, ProviderFilter, QueryFilterFilter, ReferenceFilter, RefFilter_1_1, ResourceAdapterBooleanPropertyFilter, ResourceAdapterFilter, ResourceAdapterIntegerPropertyFilter, ResourceAdapterPropertyFilter, ResourceAdapterStringPropertyFilter, ResourceReferenceFilter, RoleCapableFilter, RoleFilter, RoleTypeFilter, SegmentFilter, SegmentFilter, SegmentFilter, SegmentFilter, SegmentFilter, SegmentFilter, SequenceFilter, StateCapableFilter, StateFilter, StatefulConnectionFilter, StatelessConnectionFilter, StatelessResourceFilter, StatisticsFilter, StringPropertyFilter, StringPropertyFilter, StructuralFeatureFilter, StructureFieldFilter, StructureTypeFilter, TagFilter, TransientFilter, TypedElementFilter, UnitOfWorkFilter, UriPropertyFilter, UriPropertyFilter, ValidStateFilter, ViewCapableFilter, ViewFilter, VoidFilter

All Known Implementing Classes:

AliasTypeFilterImpl, AssociationEndFilterImpl, AssociationFilterImpl, AttributeFilterImpl, AuditableFilterImpl, AuthorityFilterImpl, BasicObjectFilterImpl, BasicStateFilterImpl, BehaviouralFeatureFilterImpl, BooleanPropertyFilterImpl, BooleanPropertyFilterImpl, ClassFilterImpl, ClassifierExternalizeClassifierParamsFilterImpl, ClassifierExternalizeResultFilterImpl, ClassifierFilterImpl, CollectionTypeFilterImpl, ComponentFilterImpl, ConfigurationFilterImpl, ConnectionFilterImpl, ConstantFilterImpl, ConstraintFilterImpl, ContextCapableFilterImpl, ContextFilterImpl, DatabaseConnectorFilterImpl, DatabaseFilterImpl, DatabaseResourceReferenceFilterImpl, DataproviderBooleanPropertyFilterImpl, DataproviderConnectorFilterImpl, DataproviderFilterImpl, DataproviderIntegerPropertyFilterImpl, DataproviderPropertyFilterImpl, DataproviderResourceFilterImpl, DataproviderResourceReferenceFilterImpl, DataproviderStringPropertyFilterImpl, DataproviderTypeBooleanPropertyFilterImpl, DataproviderTypeFilterImpl, DataproviderTypeIntegerPropertyFilterImpl, DataproviderTypePropertyFilterImpl, DataproviderTypeStringPropertyFilterImpl, DatastoreFilterImpl, DatatypeFilterImpl, DateStateExcludingEndFilterImpl, DateStateFilterImpl, DateTimeStateFilterImpl, DecimalPropertyFilterImpl, DecimalPropertyFilterImpl, DeploymentUnitFilterImpl, DomainFilterImpl, DomainFilterImpl, ElementFilterImpl, EnumerationTypeFilterImpl, ExceptionFilterImpl, ExtentCapableFilterImpl, FeatureFilterImpl, FilterFilterImpl, GeneralizableElementFilterImpl, GenericResourceReferenceFilterImpl, GetStreamResultFilterImpl, HistoryStateFilterImpl, HttpUrlConnectorFilterImpl, ImportFilterImpl, InboundCommunicationFilterImpl, IndexFilterImpl, InstanceFilterImpl, IntegerPropertyFilterImpl, IntegerPropertyFilterImpl, InvolvedFilterImpl, LockFilterImpl, ModuleFilterImpl, NamespaceFilterImpl, NamespaceFilterImpl, NamespaceFindElementsByTypeParamsFilterImpl, NamespaceFindElementsByTypeResultFilterImpl, NamespaceLookupElementParamsFilterImpl, NamespaceLookupElementResultFilterImpl, NamespaceResolveQualifiedNameParamsFilterImpl, NamespaceResolveQualifiedNameResultFilterImpl, OperationFilterImpl, OptimisticLockFilterImpl, OutboundCommunicationFilterImpl, PackageExternalizeParamsFilterImpl, PackageExternalizeResultFilterImpl, PackageFilterImpl, ParameterFilterImpl, PreferencesFilterImpl, PrimitiveTypeFilterImpl, PropertyFilterImpl, PropertyFilterImpl, PropertySetFilterImpl, ProviderFilterImpl, QueryFilterFilterImpl, ReferenceFilterImpl, RefFilter_1, RefPredicate_1, ResourceAdapterBooleanPropertyFilterImpl, ResourceAdapterFilterImpl, ResourceAdapterIntegerPropertyFilterImpl, ResourceAdapterPropertyFilterImpl, ResourceAdapterStringPropertyFilterImpl, ResourceReferenceFilterImpl, RoleCapableFilterImpl, RoleFilterImpl, RoleTypeFilterImpl, SegmentFilterImpl, SegmentFilterImpl, SegmentFilterImpl, SegmentFilterImpl, SegmentFilterImpl, SegmentFilterImpl, SequenceFilterImpl, StateCapableFilterImpl, StateFilterImpl, StatefulConnectionFilterImpl, StatelessConnectionFilterImpl, StatelessResourceFilterImpl, StatisticsFilterImpl, StringPropertyFilterImpl, StringPropertyFilterImpl, StructuralFeatureFilterImpl, StructureFieldFilterImpl, StructureTypeFilterImpl, TagFilterImpl, TransientFilterImpl, TypedElementFilterImpl, UnitOfWorkFilterImpl, UriPropertyFilterImpl, UriPropertyFilterImpl, ValidStateFilterImpl, ViewCapableFilterImpl, ViewFilterImpl, VoidFilterImpl

public interface RefFilter_1_0
extends Serializable

The RefFilter is an extension to JMI and allows to filter the Collections returned by JMI methods. The Collections returned are FilterableCollections which allow to filter the result set. The subSet() methods takes as parameter the refFilterProperties() and the orderBy() the refAttributeSpecifiers().

FilterableCollections and RefFilter_1_0 are an extension of JMI 1.0. 100% JMI-compliant applications should not use these methods.

Method Summary

void	clear() Clears the filter and removes all previously added filter values.
void	refAddValue(String fieldName, short order) Allows to specify the sort order for a field.
void	refAddValue(String fieldName, short quantor, short operator, Collection values) This operation allows to set a filter value with the semantics .
void	refAddValue(String fieldName, short quantor, short operator, RefFilter_1_0 filter) Allows to construct complex/nested filters.
Collection	refGetAttributeSpecifiers() Returns the collection of added attribute specifiers, i.e.
Collection	refGetFilterProperties() Returns the collection of added filter properties, i.e.

Method Detail

refAddValue

void refAddValue(String fieldName,
                 short quantor,
                 short operator,
                 Collection values)

This operation allows to set a filter value with the semantics . The value constants for the quantor and operator parameters are implementation-specific.

refAddValue

void refAddValue(String fieldName,
                 short quantor,
                 short operator,
                 RefFilter_1_0 filter)

Allows to construct complex/nested filters.

refAddValue

void refAddValue(String fieldName,
                 short order)

Allows to specify the sort order for a field.

refGetFilterProperties

Collection refGetFilterProperties()

Returns the collection of added filter properties, i.e. attributes added with refAddValue(fieldName, quantor, operator).

Returns:

Collection collection of org.openmdx.compatibility.base.query.FilterProperty.

refGetAttributeSpecifiers

Collection refGetAttributeSpecifiers()

Returns the collection of added attribute specifiers, i.e. attributes added with refAddValue(fieldName, order).

Returns:

Collection collection of org.openmdx.compatibility.base.dataprovider.cci.AttributeSpecifier.

clear

void clear()

Clears the filter and removes all previously added filter values.