org.objectweb.jorm.mapper.rdb.metainfo
Class RdbFilter

java.lang.Object
  extended byorg.objectweb.jorm.metainfo.lib.BasicMetaObject
      extended byorg.objectweb.jorm.mapper.rdb.metainfo.RdbFilter
All Implemented Interfaces:
Loggable, MetaObject, java.io.Serializable

public class RdbFilter
extends BasicMetaObject

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.objectweb.jorm.metainfo.lib.BasicMetaObject
logger, loggerFactory, parent
 
Constructor Summary
RdbFilter(MetaObject parent)
          Builds a new RdbFilter object.
 
Method Summary
 void addFilterColumn(java.lang.String columnName)
           
 void addPredicate(java.lang.String columnName, Predicate predicate)
           
 java.lang.String getEqualPredicateValue(java.lang.String columnname)
          Returns the predicate value associated with the filter column name.
 java.util.Set getFilterColumnNames()
          Returns a collection of filter column names.
 java.util.List getPredicates(java.lang.String filterColumnName)
          Returns a collection of Predicate objects.
 boolean isFilter(java.lang.String columnname)
          Indicates if columnname is a filter column.
 
Methods inherited from class org.objectweb.jorm.metainfo.lib.BasicMetaObject
getChildren, getLogger, getLoggerFactory, getManager, getParent, setLogger, setLoggerFactory, setLoggingOnChild, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RdbFilter

public RdbFilter(MetaObject parent)
Builds a new RdbFilter object. This object encapsulates information about filter columns. The parent object is a RdbClassMapping object.

Parameters:
parent - the parent of the current object.
Method Detail

addFilterColumn

public void addFilterColumn(java.lang.String columnName)
                     throws PException
Throws:
PException

addPredicate

public void addPredicate(java.lang.String columnName,
                         Predicate predicate)
                  throws PException
Throws:
PException

getFilterColumnNames

public java.util.Set getFilterColumnNames()
Returns a collection of filter column names.

Returns:
a collection of filter column names.

getPredicates

public java.util.List getPredicates(java.lang.String filterColumnName)
Returns a collection of Predicate objects.

Parameters:
filterColumnName - a filter column name.
Returns:
a collection of Predicate objects.

isFilter

public boolean isFilter(java.lang.String columnname)
Indicates if columnname is a filter column.

Parameters:
columnname - a filter column name.
Returns:
true, if columnname is a filter column, else false.

getEqualPredicateValue

public java.lang.String getEqualPredicateValue(java.lang.String columnname)
                                        throws PException
Returns the predicate value associated with the filter column name. If the predicate does not correspond to an equal operator, a PException is raised.

Parameters:
columnname - a filter column name.
Returns:
the predicate value associated with the filter column name.
Throws:
PException