com.idimiddleware.objectq

Class Filter

java.lang.Object

com.idimiddleware.objectq.Filter

Direct Known Subclasses:

EventFilter, InstanceFilter

public abstract class Filter
extends java.lang.Object

Instance filters and Event filters are identical in their behavior, but are used in different contexts. An Instance filter is used to specify a filter for selection of a subset of object instances, while an Event filter is used to subscribe to a subset of events.

Both consist of an id and a list of attributes. The id corresponds to that advertised by a server as being a supported filter, and the attribute list will contain the attribute values required by the filter.

For more information on scoping and filtering, see section 5.4 of RFC 1095.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	EVENT_FILTER
protected static int	INSTANCE_FILTER

Constructor Summary

Constructors

Constructor and Description
Filter() Default constructor, setting default values of 0 for id, NONE for scope, and an empty attribute list.
Filter(int id, ObjectQ.Scope scope, java.util.List<Attribute> attrs) Constructor providing all filter values.

Method Summary

Modifier and Type	Method and Description
java.util.List<Attribute>	getAttrs() Get the filter attributes.
int	getId() Get the filter id.
ObjectQ.Scope	getScope() Get the filter scope.
protected void	restore(int type, byte[] bytes, boolean idsOnly) Restore the filter from a previously flattened byte array.
protected byte[]	save(int type) Save the filter in "flattened" form.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_FILTER

protected static final int EVENT_FILTER

See Also:

Constant Field Values

INSTANCE_FILTER

protected static final int INSTANCE_FILTER

See Also:

Constant Field Values

Constructor Detail

Filter

public Filter()

Default constructor, setting default values of 0 for id, NONE for scope, and an empty attribute list.

Filter

public Filter(int id,
              ObjectQ.Scope scope,
              java.util.List<Attribute> attrs)
       throws java.lang.IllegalArgumentException

Constructor providing all filter values.

Parameters:

id - The filter id.

scope - The filter scope.

attrs - The filter attribute list.

Throws:

java.lang.IllegalArgumentException

Method Detail

getAttrs

public java.util.List<Attribute> getAttrs()

Get the filter attributes.

Returns:

The list of attributes.

getId

public int getId()

Get the filter id.

Returns:

The id.

getScope

public ObjectQ.Scope getScope()

Get the filter scope.

Returns:

The filter scope.

restore

protected void restore(int type,
                       byte[] bytes,
                       boolean idsOnly)
                throws BadMagicException

Restore the filter from a previously flattened byte array.

Parameters:

bytes - The byte array.

idsOnly - If true, the buffer contains attribute ids only; otherwise it contains attributes with their associated values.

Throws:

BadMagicException - The "magic number" was invalid.

save

protected byte[] save(int type)

Save the filter in "flattened" form.

Returns:

A byte array of the flattened filter.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object