com.portal.bas

Class PCollectingModelHandle

java.lang.Object

com.portal.bas.PModelHandle

com.portal.bas.PCollectingModelHandle

All Implemented Interfaces:

Serializable

public class PCollectingModelHandle
extends PModelHandle
implements Serializable

PCollectingModelHandle is a version of PModelHandle that contains a hash map. Use it to collect data that might otherwise require a client-server round trip. This behavior should be completely hidden.

Version:

%version: 5 % %date_modified: Mon Dec 17 21:18:17 2001 %

Author:

larrylf

See Also:

Serialized Form

Field Summary

Fields inherited from class com.portal.bas.PModelHandle

LOOKUP_DONT_UPDATE, LOOKUP_FORCE_UPDATE, LOOKUP_UPDATE_IF_NEEDED, UNTYPED

Constructor Summary

Constructors

Constructor and Description
PCollectingModelHandle(PModelHandle mh) Creates an instance of the collecting handle that is otherwise a clone of another model handle.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the local collection.
boolean	getCollectOnly() Gets the collectOnly property.
Set	getEntrySet() Gets an entire set of description:value pairs as sets of Map.Entry values.
Object	getValue(String fieldDesc) Gets a local value.
boolean	hasField(String fieldDesc) Tests to see if the local collection has a certain field description.
void	setCollectOnly(boolean colOnly) Sets the collectOnly property.
void	setValue(String fieldDesc, Object val) Sets a local value.

Methods inherited from class com.portal.bas.PModelHandle

equals, getHash, getModel, getType, hashCode, isGivenHash, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PCollectingModelHandle

public PCollectingModelHandle(PModelHandle mh)

Creates an instance of the collecting handle that is otherwise a clone of another model handle.

Parameters:

mh - a PModelHandle to copy

Method Detail

setValue

public void setValue(String fieldDesc,
                     Object val)

Sets a local value.

Parameters:

fieldDesc - a description of the field to set

val - the value to set it to

getValue

public Object getValue(String fieldDesc)

Gets a local value.

Parameters:

fieldDesc - a String description of the field to get

Returns:

The field's value.

hasField

public boolean hasField(String fieldDesc)

Tests to see if the local collection has a certain field description.

Parameters:

fieldDesc - the description to look for

Returns:

True if present; false otherwise.

getEntrySet

public Set getEntrySet()

Gets an entire set of description:value pairs as sets of Map.Entry values.

Returns:

A set of Map.Entry values.

clear

public void clear()

Clears the local collection.

setCollectOnly

public void setCollectOnly(boolean colOnly)

Sets the collectOnly property. This property controls whether or not the model cache is automatically updated with values from the local cache.

Parameters:

colOnly - true if the model handle should only collect data and not update the cache when possible; false otherwise

getCollectOnly

public boolean getCollectOnly()

Gets the collectOnly property. This property controls whether or not the model cache is automatically updated with values from the local cache.

Returns:

True if the model handle should only collect data and not update the cache when possible; false otherwise.