EclipseLink Core 4.0.2 · org.eclipse.persistence.queries.BatchFetchPolicy

Modifier and Type	Field and Description
protected List<Expression>	attributeExpressions Define the attributes to be batch fetched.
protected List<String>	attributes PERF: Cache the local batch read attribute names.
protected List<DatabaseMapping>	batchedMappings Define the mapping to be batch fetched (from mapping settings).
protected transient Map<Object, Object>	batchObjects Stores temporary map of batched objects (this queries results).
protected transient Map<Object, List<AbstractRecord>>	dataResults Stores temporary list of rows from parent batch query per batched mapping.
protected transient Map<DatabaseMapping, ReadQuery>	mappingQueries PERF: Used internally to store the prepared mapping queries.
protected int	size Define the batch size for IN style batch fetching.
protected BatchFetchType	type Define the type of batch fetching to use.

Access	Constructor and Description
public	BatchFetchPolicy()
public	BatchFetchPolicy(BatchFetchType type)

Method Summary

Modifier and Type	Method and Description
public void	addDataResults(AbstractRecord row) INTERNAL: Add the row to the set of data results.
public BatchFetchPolicy	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public List<AbstractRecord>	getAllDataResults() INTERNAL: Return temporary list of rows from parent batch query per batched mapping.
public List<Expression>	getAttributeExpressions() INTERNAL: Return all attributes specified for batch reading.
public List<String>	getAttributes() INTERNAL: PERF: Return the cached local (only) batch read attribute names.
public List<DatabaseMapping>	getBatchedMappings() INTERNAL: Return any mappings that are always batched.
public Map<Object, Object>	getBatchObjects() INTERNAL: Return temporary map of batched objects.
public List<AbstractRecord>	getDataResults(DatabaseMapping mapping) INTERNAL: Return the remaining data results for the mapping.
public Map<Object, List<AbstractRecord>>	getDataResults() INTERNAL: Return temporary list of rows from parent batch query per batched mapping.
public Map<DatabaseMapping, ReadQuery>	getMappingQueries() INTERNAL: PERF: Return the internally stored prepared mapping queries.
public int	getSize() Return the batch fetch size.
public BatchFetchType	getType() Return the batch fetch type, (JOIN, IN, EXISTS).
public boolean	hasAttributes() INTERNAL: Return true is this query has batching
public boolean	isAttributeBatchRead(String attributeName) INTERNAL: Return if the attribute is specified for batch reading.
public boolean	isAttributeBatchRead(ClassDescriptor mappingDescriptor, String attributeName) INTERNAL: Return if the attribute is specified for batch reading.
public boolean	isEXISTS() Return if using the EXISTS fetch type.
public boolean	isIN() Return if using the IN fetch type.
public boolean	isJOIN() Return if using the JOIN fetch type.
public void	setAttributeExpressions(List<Expression> attributeExpressions)
public void	setAttributes(List<String> attributes) INTERNAL: PERF: Set the cached local (only) batch read attribute names.
public void	setBatchedMappings(List<DatabaseMapping> batchedMappings) INTERNAL: Set any mappings that are always batched.
public void	setBatchObjects(Map<Object, Object> batchObjects) INTERNAL: Set temporary map of batched objects.
public void	setDataResults(DatabaseMapping mapping, List<AbstractRecord> rows) INTERNAL: Set the remaining data results for the mapping.
public void	setDataResults(List<AbstractRecord> rows) INTERNAL: Set the rows to the set of data results for each mapping.
public void	setDataResults(Map<Object, List<AbstractRecord>> dataResults) INTERNAL: Set temporary list of rows from parent batch query per batched mapping.
public void	setMappingQueries(Map<DatabaseMapping, ReadQuery> mappingQueries) INTERNAL: PERF: Set the internally stored prepared mapping queries.
public void	setSize(int size) Set the batch fetch size.
public void	setType(BatchFetchType type) Set the batch fetch type, (JOIN, IN, EXISTS).

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

attributeExpressions	back to summary
protected List<Expression> attributeExpressions Define the attributes to be batch fetched.

attributes	back to summary
protected List<String> attributes PERF: Cache the local batch read attribute names.

batchedMappings	back to summary
protected List<DatabaseMapping> batchedMappings Define the mapping to be batch fetched (from mapping settings).

batchObjects	back to summary
protected transient Map<Object, Object> batchObjects Stores temporary map of batched objects (this queries results).

dataResults	back to summary
protected transient Map<Object, List<AbstractRecord>> dataResults Stores temporary list of rows from parent batch query per batched mapping.

mappingQueries	back to summary
protected transient Map<DatabaseMapping, ReadQuery> mappingQueries PERF: Used internally to store the prepared mapping queries.

size	back to summary
protected int size Define the batch size for IN style batch fetching.

type	back to summary
protected BatchFetchType type Define the type of batch fetching to use.

BatchFetchPolicy	back to summary
public BatchFetchPolicy()

BatchFetchPolicy	back to summary
public BatchFetchPolicy(BatchFetchType type)

Method Detail

addDataResults	back to summary
public void addDataResults(AbstractRecord row) INTERNAL: Add the row to the set of data results. This is used for IN batching in batches.

clone back to summary

clone	back to summary
public BatchFetchPolicy clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:BatchFetchPolicy a clone of this instance. Annotations @Override

public BatchFetchPolicy clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:BatchFetchPolicy

a clone of this instance.

Annotations

@Override

getAllDataResults	back to summary
public List<AbstractRecord> getAllDataResults() INTERNAL: Return temporary list of rows from parent batch query per batched mapping. This is used for IN batching in batches.

getAttributeExpressions	back to summary
public List<Expression> getAttributeExpressions() INTERNAL: Return all attributes specified for batch reading.

getAttributes	back to summary
public List<String> getAttributes() INTERNAL: PERF: Return the cached local (only) batch read attribute names.

getBatchedMappings	back to summary
public List<DatabaseMapping> getBatchedMappings() INTERNAL: Return any mappings that are always batched.

getBatchObjects	back to summary
public Map<Object, Object> getBatchObjects() INTERNAL: Return temporary map of batched objects.

getDataResults	back to summary
public List<AbstractRecord> getDataResults(DatabaseMapping mapping) INTERNAL: Return the remaining data results for the mapping. This is used for IN batching in batches.

getDataResults	back to summary
public Map<Object, List<AbstractRecord>> getDataResults() INTERNAL: Return temporary list of rows from parent batch query per batched mapping. This is used for IN batching in batches.

getMappingQueries	back to summary
public Map<DatabaseMapping, ReadQuery> getMappingQueries() INTERNAL: PERF: Return the internally stored prepared mapping queries.

getSize	back to summary
public int getSize() Return the batch fetch size.

getType	back to summary
public BatchFetchType getType() Return the batch fetch type, (JOIN, IN, EXISTS).

hasAttributes	back to summary
public boolean hasAttributes() INTERNAL: Return true is this query has batching

isAttributeBatchRead	back to summary
public boolean isAttributeBatchRead(String attributeName) INTERNAL: Return if the attribute is specified for batch reading.

isAttributeBatchRead	back to summary
public boolean isAttributeBatchRead(ClassDescriptor mappingDescriptor, String attributeName) INTERNAL: Return if the attribute is specified for batch reading.

isEXISTS	back to summary
public boolean isEXISTS() Return if using the EXISTS fetch type.

isIN	back to summary
public boolean isIN() Return if using the IN fetch type.

isJOIN	back to summary
public boolean isJOIN() Return if using the JOIN fetch type.

setAttributeExpressions	back to summary
public void setAttributeExpressions(List<Expression> attributeExpressions)

setAttributes	back to summary
public void setAttributes(List<String> attributes) INTERNAL: PERF: Set the cached local (only) batch read attribute names.

setBatchedMappings	back to summary
public void setBatchedMappings(List<DatabaseMapping> batchedMappings) INTERNAL: Set any mappings that are always batched.

setBatchObjects	back to summary
public void setBatchObjects(Map<Object, Object> batchObjects) INTERNAL: Set temporary map of batched objects.

setDataResults	back to summary
public void setDataResults(DatabaseMapping mapping, List<AbstractRecord> rows) INTERNAL: Set the remaining data results for the mapping. This is used for IN batching in batches.

setDataResults	back to summary
public void setDataResults(List<AbstractRecord> rows) INTERNAL: Set the rows to the set of data results for each mapping. This is used for IN batching in batches.

setDataResults	back to summary
public void setDataResults(Map<Object, List<AbstractRecord>> dataResults) INTERNAL: Set temporary list of rows from parent batch query per batched mapping. This is used for IN batching in batches.

setMappingQueries	back to summary
public void setMappingQueries(Map<DatabaseMapping, ReadQuery> mappingQueries) INTERNAL: PERF: Set the internally stored prepared mapping queries.

setSize	back to summary
public void setSize(int size) Set the batch fetch size.

setType	back to summary
public void setType(BatchFetchType type) Set the batch fetch type, (JOIN, IN, EXISTS).

public Class BatchFetchPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail