org.dmd.dmc

Class DmcFilter

java.lang.Object

org.dmd.dmc.DmcFilter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClassFilter

public abstract class DmcFilter
extends Object
implements Serializable

The DmcFilter provides a common base class for the implementation of code that can determine whether or not a particular Dark Matter Object meets a set of criteria. Due to the fact that there are so many different ways to specify filters or matching criteria or queries, the interface to a filter is very simplistic at this level. However, having a common filter interface means that cache implementations don't have to understand the internal workings of the filter.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DmcFilter()

Method Summary

Modifier and Type	Method and Description
abstract DmcFilter	cloneIt()
abstract void	deserializeIt(DmcInputStreamIF dis) Likewise, they must also be individually deserializable.
abstract String	getFilterClass()
abstract String	getFilterString() Regardless of how you implement your filtering mechanisms, you must be able to represent the filter as a String and parse it from that String.
abstract boolean	objectMatches(DmcObject obj) Applies the filter logic to the object.
abstract void	serializeIt(DmcOutputStreamIF dos) The filter values must be individually serializable.
String	toString() Return the filter as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

DmcFilter

public DmcFilter()

Method Detail

objectMatches

public abstract boolean objectMatches(DmcObject obj)

Applies the filter logic to the object.

Parameters:

obj - The object to be tested.

Returns:

true if the object matches the criteria

getFilterString

public abstract String getFilterString()

Regardless of how you implement your filtering mechanisms, you must be able to represent the filter as a String and parse it from that String. This method forces you to implement a string format.

Returns:

the String form of the filter.

cloneIt

public abstract DmcFilter cloneIt()

Returns:

a clone of the DmcFilter derivative.

getFilterClass

public abstract String getFilterClass()

Returns:

just the name of the name class e.g. ClassFilter, AttributeFilter etc.

serializeIt

public abstract void serializeIt(DmcOutputStreamIF dos)
                          throws Exception

The filter values must be individually serializable.

Parameters:

dos - The output stream.

Throws:

Exception

deserializeIt

public abstract void deserializeIt(DmcInputStreamIF dis)
                            throws Exception

Likewise, they must also be individually deserializable.

Parameters:

dis - The input stream.

Throws:

Exception

toString

public String toString()

Return the filter as a String.

Overrides:

toString in class Object