|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.dna.graph.requests.Request org.jboss.dna.graph.requests.CacheableRequest org.jboss.dna.graph.requests.ReadBlockOfChildrenRequest
public class ReadBlockOfChildrenRequest
Instruction to read a block of the children of a node, where the block is dictated by the starting
index
and the maximum number of children
to include in the block. This command is useful when paging through
a large number of children.
ReadNextBlockOfChildrenRequest
,
Serialized FormField Summary | |
---|---|
static int |
INDEX_NOT_USED
|
Constructor Summary | |
---|---|
ReadBlockOfChildrenRequest(Location of,
int startingIndex,
int count)
Create a request to read a block of the children of a node at the supplied location. |
Method Summary | |
---|---|
void |
addChild(Location child)
Add to the list of children that has been read the child with the given path and identification properties. |
void |
addChild(Path pathToChild,
Property idProperty)
Add to the list of children that has been read the child with the given path and identification property. |
void |
addChild(Path pathToChild,
Property firstIdProperty,
Property... remainingIdProperties)
Add to the list of children that has been read the child with the given path and identification properties. |
int |
count()
Get the maximum number of children that may be returned in the block. |
int |
endingBefore()
Get the index past the last child that is to be included in the block. |
boolean |
equals(Object obj)
|
Location |
getActualLocationOfNode()
Get the actual location of the node whose children were read. |
List<Location> |
getChildren()
Get the children that were read from the RepositoryConnection after the request was processed. |
boolean |
isReadOnly()
Return whether this request only reads information. |
Location |
of()
Get the location defining the node whose children are to be read. |
void |
setActualLocationOfNode(Location actual)
Sets the actual and complete location of the node whose children have been read. |
int |
startingAtIndex()
Get the starting index of the block, which is the index of the first child to include. |
String |
toString()
|
Methods inherited from class org.jboss.dna.graph.requests.CacheableRequest |
---|
getCachePolicy, getTimeLoaded, setCachePolicy, setTimeLoaded |
Methods inherited from class org.jboss.dna.graph.requests.Request |
---|
cancel, getError, hasError, isCancelled, setError |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int INDEX_NOT_USED
Constructor Detail |
---|
public ReadBlockOfChildrenRequest(Location of, int startingIndex, int count)
same-name-sibiling index
, but rather is the index of the child as if the children were in
an array.
of
- the location of the node whose children are to be readstartingIndex
- the index of the first child to be included in the blockcount
- the maximum number of children that should be included in the block
IllegalArgumentException
- if the location is null, if startingIndex
is negative, or if
count is less than 1.
Method Detail |
---|
public boolean isReadOnly()
isReadOnly
in class Request
Request.isReadOnly()
public Location of()
public int count()
startingAtIndex()
,
endingBefore()
public int startingAtIndex()
same-name-sibiling index
.
endingBefore()
endingBefore()
,
count()
public int endingBefore()
same-name-sibiling index
.
startingAtIndex()
.startingAtIndex()
,
count()
public List<Location> getChildren()
RepositoryConnection
after the request was processed. Each child is
represented by a location.
public void addChild(Location child)
child
- the location of the child that was read
IllegalArgumentException
- if the location is nulladdChild(Path, Property)
,
addChild(Path, Property, Property...)
public void addChild(Path pathToChild, Property firstIdProperty, Property... remainingIdProperties)
pathToChild
- the path of the child that was just readfirstIdProperty
- the first identification property of the child that was just readremainingIdProperties
- the remaining identification properties of the child that was just read
IllegalArgumentException
- if the path or identification properties are nulladdChild(Location)
,
addChild(Path, Property)
public void addChild(Path pathToChild, Property idProperty)
pathToChild
- the path of the child that was just readidProperty
- the identification property of the child that was just read
IllegalArgumentException
- if the path or identification properties are nulladdChild(Location)
,
addChild(Path, Property, Property...)
public void setActualLocationOfNode(Location actual)
path
.
actual
- the actual location of the node being read, or null if the current location
should be used
IllegalArgumentException
- if the actual location does not represent the same
location
as the current location
, or if the actual location does not have a path.public Location getActualLocationOfNode()
public boolean equals(Object obj)
equals
in class Object
Object.equals(java.lang.Object)
public String toString()
toString
in class Object
Object.toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |