Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.ejb.plugins.cmp.jdbc.metadata
Class JDBCReadAheadMetaData

java.lang.Object
  extended byorg.jboss.ejb.plugins.cmp.jdbc.metadata.JDBCReadAheadMetaData
public class JDBCReadAheadMetaData
extends java.lang.Object

Imutable class which holds all the information about read-ahead settings. It loads its data from standardjbosscmp-jdbc.xml and jbosscmp-jdbc.xml

Field Summary
static JDBCReadAheadMetaData (src) DEFAULT
           
 
Constructor Summary
JDBCReadAheadMetaData(org.w3c.dom.Element element, JDBCReadAheadMetaData (src)  defaultValue)
          Constructs read ahead meta data with the data contained in the read-ahead xml element from a jbosscmp-jdbc xml file.
JDBCReadAheadMetaData(java.lang.String strategy, int pageSize, java.lang.String eagerLoadGroup)
          Constructs read ahead meta data with specified strategy, pageSize and eagerLoadGroup.
JDBCReadAheadMetaData(java.lang.String strategy, int pageSize, java.lang.String eagerLoadGroup, java.util.List leftJoins)
           
 
Method Summary
 java.lang.String getEagerLoadGroup()
          Gets the eager load group.
 java.util.Iterator getLeftJoins()
           
 int getPageSize()
          Gets the read ahead page size.
 boolean isNone()
          Is read ahead strategy is none.
 boolean isOnFind()
          Is the read ahead stratey on-find
 boolean isOnLoad()
          Is the read ahead stratey on-load
 java.lang.String toString()
          Returns a string describing this JDBCReadAheadMetaData.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT

public static final JDBCReadAheadMetaData (src)  DEFAULT
Constructor Detail

JDBCReadAheadMetaData

public JDBCReadAheadMetaData(java.lang.String strategy,
                             int pageSize,
                             java.lang.String eagerLoadGroup)
Constructs read ahead meta data with specified strategy, pageSize and eagerLoadGroup. NOTE: used only in tests.

JDBCReadAheadMetaData

public JDBCReadAheadMetaData(java.lang.String strategy,
                             int pageSize,
                             java.lang.String eagerLoadGroup,
                             java.util.List leftJoins)

JDBCReadAheadMetaData

public JDBCReadAheadMetaData(org.w3c.dom.Element element,
                             JDBCReadAheadMetaData (src)  defaultValue)
                      throws DeploymentException (src)
Constructs read ahead meta data with the data contained in the read-ahead xml element from a jbosscmp-jdbc xml file. Optional values of the xml element that are not present are instead loaded from the defalutValues parameter.

Parameters:
element - the xml Element which contains the read-ahead metadata
Throws:
DeploymentException (src) - if the xml element is invalid
Method Detail

isNone

public boolean isNone()
Is read ahead strategy is none.

isOnLoad

public boolean isOnLoad()
Is the read ahead stratey on-load

isOnFind

public boolean isOnFind()
Is the read ahead stratey on-find

getPageSize

public int getPageSize()
Gets the read ahead page size.

getEagerLoadGroup

public java.lang.String getEagerLoadGroup()
Gets the eager load group.

getLeftJoins

public java.util.Iterator getLeftJoins()

toString

public java.lang.String toString()
Returns a string describing this JDBCReadAheadMetaData.

Returns:
a string representation of the object
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD