IncrementalFaultList

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> objectstyle >> cayenne >> [ access overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.objectstyle.cayenne.access.IncrementalFaultList

SOURCE |

Download org.objectstyle.cayenne.access.IncrementalFaultList

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.objectstyle.cayenne.access
Class IncrementalFaultList

java.lang.Object
  org.objectstyle.cayenne.access.IncrementalFaultList

All Implemented Interfaces:: java.util.Collection, java.lang.Iterable, java.util.List

public class IncrementalFaultList
extends java.lang.Object
implements java.util.List

A synchronized list that serves as a container of DataObjects. It is returned when a paged query is performed by DataContext. On creation, only the first "page" is fully resolved, for the rest of the objects only their ObjectIds are read. Pages following the first page are resolved on demand only. On access to an element, the list would ensure that this element as well as all its siblings on the same page are fully resolved.

Note that this list would only allow addition of DataObjects. Attempts to add any other object types will result in an exception.

Performance note: certain operations like toArray would trigger full list fetch.

Field Summary

protected DataContext dataContext


protected java.util.List elements


protected org.objectstyle.cayenne.query.SelectQuery internalQuery


protected int pageSize


protected org.objectstyle.cayenne.map.ObjEntity rootEntity


protected int unfetchedObjects


Constructor Summary

IncrementalFaultList(DataContext dataContext, org.objectstyle.cayenne.query.GenericSelectQuery query)


IncrementalFaultList(IncrementalFaultList list)
          Creates a new list copying settings from another list.

Method Summary

void add(int index, java.lang.Object element)
          Insert an element into the list at a given position (optional operation).

boolean add(java.lang.Object o)
          Add an element to the end of the list (optional operation).

boolean addAll(java.util.Collection c)
          Add the contents of a collection to the end of the list (optional operation).

boolean addAll(int index, java.util.Collection c)
          Insert the contents of a collection into the list at a given position (optional operation).

void clear()
          Clear the list, such that a subsequent call to isEmpty() would return true (optional operation).

boolean contains(java.lang.Object o)
          Test whether this list contains a given object as one of its elements.

boolean containsAll(java.util.Collection c)
          Test whether this list contains every element in a given collection.

protected void fillIn(org.objectstyle.cayenne.query.GenericSelectQuery query)
          Performs initialization of the internal list of objects.

java.lang.Object get(int index)
          Get the element at a given index in this list.

DataContext getDataContext()
          Returns the dataContext.

int getPageSize()
          Returns the pageSize.

int getUnfetchedObjects()
          Returns a total number of objects that are not resolved yet.

int indexOf(java.lang.Object o)
          Obtain the first index at which a given object is to be found in this list.

boolean isEmpty()
          Test whether this list is empty, that is, if size() == 0.

java.util.Iterator iterator()
          This method would resolve all unresolved objects and then return an iterator over an internal list.

int lastIndexOf(java.lang.Object o)
          Obtain the last index at which a given object is to be found in this list.

java.util.ListIterator listIterator()
          This method would resolve all unresolved objects and then return a list iterator over an internal list.

java.util.ListIterator listIterator(int index)
          This method would resolve all unresolved objects and then return a list iterator over an internal list.

int pageIndex(int elementIndex)


java.lang.Object remove(int index)
          Remove the element at a given position in this list (optional operation).

boolean remove(java.lang.Object o)
          Remove the first occurence of an object from this list (optional operation).

boolean removeAll(java.util.Collection c)
          Remove all elements of a given collection from this list (optional operation).

void resolveAll()
          Will resolve all unread objects.

protected void resolveInterval(int fromIndex, int toIndex)
          Resolves a sublist of objects starting at fromIndex up to but not including toIndex.

boolean retainAll(java.util.Collection c)
          Remove all elements of this list that are not contained in a given collection (optional operation).

java.lang.Object set(int index, java.lang.Object element)
          Replace an element of this list with another object (optional operation).

int size()
          Get the number of elements in this list.

java.util.List subList(int fromIndex, int toIndex)
          Obtain a List view of a subsection of this list, from fromIndex (inclusive) to toIndex (exclusive).

java.lang.Object[] toArray()
          Copy the current contents of this list into an array.

java.lang.Object[] toArray(java.lang.Object[] a)
          Copy the current contents of this list into an array.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode

Field Detail

pageSize

protected int pageSize

elements

protected java.util.List elements

dataContext

protected DataContext dataContext

rootEntity

protected org.objectstyle.cayenne.map.ObjEntity rootEntity

internalQuery

protected org.objectstyle.cayenne.query.SelectQuery internalQuery

unfetchedObjects

protected int unfetchedObjects

Constructor Detail

IncrementalFaultList

public IncrementalFaultList(IncrementalFaultList list)

Creates a new list copying settings from another list. Elements WILL NOT be copied or fetched.

IncrementalFaultList

public IncrementalFaultList(DataContext dataContext,
                            org.objectstyle.cayenne.query.GenericSelectQuery query)

Method Detail

fillIn

protected void fillIn(org.objectstyle.cayenne.query.GenericSelectQuery query)

Performs initialization of the internal list of objects. Only the first page is fully resolved. For the rest of the list, only ObjectIds are read.

resolveAll

public void resolveAll()

Will resolve all unread objects.

resolveInterval

protected void resolveInterval(int fromIndex,
                               int toIndex)

Resolves a sublist of objects starting at fromIndex up to but not including toIndex. Internally performs bound checking and trims indexes accordingly.

pageIndex

public int pageIndex(int elementIndex)

getDataContext

public DataContext getDataContext()

Returns the dataContext.

getPageSize

public int getPageSize()

Returns the pageSize.

listIterator

public java.util.ListIterator listIterator()

This method would resolve all unresolved objects and then return a list iterator over an internal list.

Specified by:: listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int index)

This method would resolve all unresolved objects and then return a list iterator over an internal list.

Specified by:: listIterator in interface java.util.List

iterator

public java.util.Iterator iterator()

This method would resolve all unresolved objects and then return an iterator over an internal list.

Specified by:: iterator in interface java.util.List