|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.compoze.collab.FetchProfile
public class FetchProfile
This class holds a list of keys to be retrieved from the server.
FetchProfile
s can be used to bring back only those properties
on an item that you need, which will increase the performance of your
application.
Field Summary | |
---|---|
static FetchProfile |
ALL
Represents a FetchProfile that includes only the keys
specified by a TYPE_ALL FetchProfile . |
static FetchProfile |
CONTAINER_DEFAULT
Represents a FetchProfile that includes only the keys
specified by a TYPE_CONTAINER_DEFAULT FetchProfile . |
static FetchProfile |
DEFAULT
Represents a FetchProfile that includes only the keys
specified by a TYPE_DEFAULT FetchProfile . |
static FetchProfile |
MINIMUM
Represents a FetchProfile that includes only the keys
specified by a TYPE_MINIMUM FetchProfile . |
static int |
TYPE_ALL
Represents a FetchProfile type that includes all keys for an
Item (as defined by the provider). |
static int |
TYPE_CONTAINER_DEFAULT
Represents a FetchProfile type that includes all default keys
for the default ItemClass defined for the Container
in which the query occurs. |
static int |
TYPE_DEFAULT
Represents a FetchProfile type that includes the default keys
for each Item based on its ItemClass . |
static int |
TYPE_MINIMUM
Represents a FetchProfile type that includes the minimum keys
for the Item . |
Constructor Summary | |
---|---|
FetchProfile()
Constructor (no initial keys). |
|
FetchProfile(Key[] keys)
Constructor. |
|
FetchProfile(Key[] keys,
int iType)
Constructor. |
Method Summary | |
---|---|
void |
addKey(Key key)
Adds a key to the profile. |
void |
addKeys(Key[] keys)
Adds keys to the profile. |
boolean |
contains(Key key)
Determines if the profile contains the specified key. |
boolean |
equals(Object obj)
|
Key[] |
getKeys()
Gets all of the keys in the profile. |
int |
getType()
Gets the FetchProfile type which defines what if any standard
keys are to be retrieved in addition to the specified keys. |
int |
hashCode()
|
int |
size()
Gets the number of keys specified in the FetchProfile (does not
include the keys specified by the TYPE_ constants). |
String |
toString()
Returns a string representation of the object. |
void |
updateDigest(MessageDigest digest)
Updates the specified MessageDigest with the object's internal state. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int TYPE_ALL
FetchProfile
type that includes all keys for an
Item
(as defined by the provider).
public static final int TYPE_DEFAULT
FetchProfile
type that includes the default keys
for each Item
based on its ItemClass
. Note that,
depending on the provider implementation using this FetchProfile
may require two queries, one to retrieve the ItemClass
es so
that the default properties are known and one to actually retrieve the
Item
s.
public static final int TYPE_MINIMUM
FetchProfile
type that includes the minimum keys
for the Item
.
public static final int TYPE_CONTAINER_DEFAULT
FetchProfile
type that includes all default keys
for the default ItemClass
defined for the Container
in which the query occurs.
public static final FetchProfile ALL
FetchProfile
that includes only the keys
specified by a TYPE_ALL
FetchProfile
.
No keys may be added to this fixed FetchProfile
.
public static final FetchProfile DEFAULT
FetchProfile
that includes only the keys
specified by a TYPE_DEFAULT
FetchProfile
.
No keys may be added to this fixed FetchProfile
.
public static final FetchProfile MINIMUM
FetchProfile
that includes only the keys
specified by a TYPE_MINIMUM
FetchProfile
.
No keys may be added to this fixed FetchProfile
.
public static final FetchProfile CONTAINER_DEFAULT
FetchProfile
that includes only the keys
specified by a TYPE_CONTAINER_DEFAULT
FetchProfile
.
No keys may be added to this fixed FetchProfile
.
Constructor Detail |
---|
public FetchProfile()
public FetchProfile(Key[] keys)
keys
- the keys for the profilepublic FetchProfile(Key[] keys, int iType)
Method Detail |
---|
public void addKey(Key key)
key
- the key to add (not null
)
CollaborationRuntimeException
- when the FetchProfile
is one of the fixed profiles specified in the members of this classpublic void addKeys(Key[] keys)
keys
- the keys to add (not null
)public boolean contains(Key key)
key
- the key to check (not null
)
true
if the profile contains the specified keypublic Key[] getKeys()
null
)public int size()
FetchProfile
(does not
include the keys specified by the TYPE_
constants).
public int getType()
FetchProfile
type which defines what if any standard
keys are to be retrieved in addition to the specified keys.
TYPE_
constants)public boolean equals(Object obj)
equals
in class Object
Object.equals(java.lang.Object)
public int hashCode()
hashCode
in class Object
Object.hashCode()
public String toString()
toString
in class Object
public void updateDigest(MessageDigest digest)
IDigestSupport
updateDigest
in interface IDigestSupport
digest
- the digest to update (not null
)
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |