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

java.lang.Object
  org.jboss.ejb.plugins.cmp.jdbc.metadata.JDBCReadAheadMetaData

public class JDBCReadAheadMetaData
extends Object

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

Version:

$Revision: 1.12 $

Author:

Oleg Nitz, Alexey Loubyansky

Field Summary

static JDBCReadAheadMetaData

DEFAULT

Constructor Summary

JDBCReadAheadMetaData(Element element, JDBCReadAheadMetaData defaultValue)
Constructs read ahead meta data with the data contained in the read-ahead xml element from a jbosscmp-jdbc xml file.

JDBCReadAheadMetaData(String strategy, int pageSize, String eagerLoadGroup)
Constructs read ahead meta data with specified strategy, pageSize and eagerLoadGroup.

JDBCReadAheadMetaData(String strategy, int pageSize, String eagerLoadGroup, List leftJoins)

Method Summary

String	getEagerLoadGroup() Gets the eager load group.
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
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 DEFAULT

Constructor Detail

JDBCReadAheadMetaData

public JDBCReadAheadMetaData(String strategy,
                             int pageSize,
                             String eagerLoadGroup)

Constructs read ahead meta data with specified strategy, pageSize and eagerLoadGroup. NOTE: used only in tests.

JDBCReadAheadMetaData

public JDBCReadAheadMetaData(String strategy,
                             int pageSize,
                             String eagerLoadGroup,
                             List leftJoins)

JDBCReadAheadMetaData

public JDBCReadAheadMetaData(Element element,
                             JDBCReadAheadMetaData defaultValue)
                      throws org.jboss.deployment.DeploymentException

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:

org.jboss.deployment.DeploymentException - 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 String getEagerLoadGroup()

Gets the eager load group.

getLeftJoins

public Iterator getLeftJoins()

toString

public String toString()

Returns a string describing this JDBCReadAheadMetaData.

Overrides:

toString in class Object

Returns:

a string representation of the object