com.goldencode.p2j.util

Class HandleResource

java.lang.Object

com.goldencode.p2j.util.HandleResource

All Implemented Interfaces:

CommonHandle, Deletable, InstantiatingProcedure, WrappedResource, Printable

Direct Known Subclasses:

ClientPrincipal, DataRelation, HandleChain, LegacyLogManagerImpl, SOAPFaultDetailImpl, SOAPFaultImpl, TransactionImpl, TreeNodeCollectionResource, TreeNodeResource

public abstract class HandleResource
extends java.lang.Object
implements Printable, CommonHandle, InstantiatingProcedure, Deletable

This acts as a superclass which implements:

attribute or base method	API
TYPE	resourceType() and type()
INSTANTIATING-PROCEDURE	instantiatingProcedure()
Unknown status	unknown()
Read only field error	readOnlyError(String, Object)
Invalid attribute access	invalidAttribute(String, boolean)

The abstract class also provides setters for the implemented attributes which are not defined inside the interfaces to be used for initializing of those attributes

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.Class<?>,java.lang.String>	CLS_2_RES A mapping of resource names for each FWD class implementing a resource.
private int	hashCode Cached hash code.
private java.lang.Long	id The resource's ID.
protected java.lang.ref.WeakReference<java.lang.Object>	instProc Weak reference to the instantiating procedure.
protected ProcedureManager.ProcedureHelper	pm Helper to use the ProcedureManager without any context local lookups.
private int	triggerRegistration The number of trigger registration (ever).
private java.lang.String	type Variable for holding the type attribute

Constructor Summary

Constructors

Modifier	Constructor and Description
	HandleResource() Default c'tor.
protected	HandleResource(boolean dynamic) Initialize this resource by determining its type.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	_instantiatingProcedure() Getter for the INSTANTIATING-PROCEDURE attribute, as direct resource.
void	addToPool(character pool) Add this resource to the WidgetPool.
void	delete() Perform actual delete of an resource.
protected void	doDelete() Perform actual delete of an resource.
boolean	equals(java.lang.Object obj) Determine whether this object is equivalent to the specified object.
int	hashCode() Return the hash code for this object.
java.lang.Long	id() Get this resource's ID, if is already set.
void	id(long id) Set this resource's ID.
protected boolean	implicitDeletion() Check if the resource may be implicitly deleted.
void	incrementTrigger() Increment the triggerRegistration counter.
handle	instantiatingProcedure() Getter for the INSTANTIATING-PROCEDURE attribute.
protected void	invalidAttribute(java.lang.String attr, boolean setter) To be used only in cases a getter for a not-supported attribute is forced to be implemented by the resource.
protected boolean	processResource() Check if this resource must be processed via ProcedureManager.processResource(com.goldencode.p2j.util.WrappedResource, boolean), once it has been instantiated.
void	readOnlyError(java.lang.String attr) Deprecated. Use the overloaded method with multiple arguments. This API is deprecated because of two reasons: first, it looses the possible side effect of the assigned expression (consider the case when it is a function or method, but not exclusively). Secondly, some (if not all) are unknown value sensitive, meaning that, prior testing whether this is a writable attribute, P4GL checks first if the expression is unknown and if this value is supported. In this case a different error condition is raised.
void	readOnlyError(java.lang.String attribute, java.lang.Object expr) Shows a specific error, as this read-only attribute was used on the right-side of an assignment.
static void	registerResource(java.lang.Class clazz, java.lang.String name) Registers a new resource in the internal map of resource class to resource name.
protected boolean	resourceDelete() Worker to be implemented by each resource.
character	resourceType() Get the type of this handle.
protected void	setInstantiatingProcedure(handle hproc) Set the instantiating procedure for this resource.
java.lang.String	toString() Returns a string representation of the object.
java.lang.String	type() Get the type of this handle as type of String.
protected static void	unableToAssignUnknown(java.lang.String attribute, java.lang.String widgetType) Show an error complaining that the UNKNOWN value cannot be assigned to a specified attribute.
boolean	unknown() A newly-created resource is always not-unknown.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

valid

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

CLS_2_RES

private static final java.util.Map<java.lang.Class<?>,java.lang.String> CLS_2_RES

A mapping of resource names for each FWD class implementing a resource.

instProc

protected java.lang.ref.WeakReference<java.lang.Object> instProc

Weak reference to the instantiating procedure.

type

private java.lang.String type

Variable for holding the type attribute

id

private java.lang.Long id

The resource's ID. Remains null until the ID is requested via handle.resourceId(com.goldencode.p2j.util.WrappedResource)

triggerRegistration

private int triggerRegistration

The number of trigger registration (ever). It will not reflect trigger deregistration.

hashCode

private int hashCode

Cached hash code.

pm

protected final ProcedureManager.ProcedureHelper pm

Helper to use the ProcedureManager without any context local lookups.

Constructor Detail

HandleResource

public HandleResource()

Default c'tor.

HandleResource

protected HandleResource(boolean dynamic)

Initialize this resource by determining its type.

The resource's type is determined from a LegacyResource annotation, which is searched in these locations, in this order:

1. The class implementing the resource in P2J is checked for an annotation. If found, this is used to determine the resource type.
2. The entire interface hierarchy is checked. There should be only one interface with a LegacyResource annotation; if there is more than annotated interface, then n IllegalStateException is thrown.

Parameters:

dynamic - Flag indicating if this is a static or dynamic resource.

Throws:

java.lang.IllegalStateException - If the resource type could not be determined from a LegacyResource annotation, after checking the interface hierarchy, or more than one interface is annotated.

Method Detail

registerResource

public static void registerResource(java.lang.Class clazz,
                                    java.lang.String name)

Registers a new resource in the internal map of resource class to resource name.

Parameters:

clazz - Resource class.

name - Resource name.

equals

public final boolean equals(java.lang.Object obj)

Determine whether this object is equivalent to the specified object. Forces the identity equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object to test for equality.

Returns:

true if equivalent, else false.

hashCode

public final int hashCode()

Return the hash code for this object. Overrides the parent's behavior to return a value which is cached at construction and does not change. Implemented as a performance enhancement.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code.

id

public java.lang.Long id()

Get this resource's ID, if is already set.

Specified by:

id in interface WrappedResource

Returns:

The resource's ID or null if not set.

id

public void id(long id)

Set this resource's ID.

Specified by:

id in interface WrappedResource

Parameters:

id - The resource's ID.

resourceType

public character resourceType()

Get the type of this handle.

Specified by:

resourceType in interface CommonHandle

Returns:

See above.

unknown

public boolean unknown()

A newly-created resource is always not-unknown. If implementations need to return something different, then override this method.

Specified by:

unknown in interface WrappedResource

Returns:

always false

readOnlyError

@Deprecated
public void readOnlyError(java.lang.String attr)

Deprecated. Use the overloaded method with multiple arguments.

This API is deprecated because of two reasons: first, it looses the possible side effect of the assigned expression (consider the case when it is a function or method, but not exclusively). Secondly, some (if not all) are unknown value sensitive, meaning that, prior testing whether this is a writable attribute, P4GL checks first if the expression is unknown and if this value is supported. In this case a different error condition is raised.

Show a specific error, as this read-only attribute was used on the right-side of an assignment.

Specified by:

readOnlyError in interface CommonHandle

Parameters:

attr - The read-only attribute.

readOnlyError

public void readOnlyError(java.lang.String attribute,
                          java.lang.Object expr)

Shows a specific error, as this read-only attribute was used on the right-side of an assignment. If the expr is evaluated to ? (unknown value) and this attribute does not support it, a specific error is raised.

Specified by:

readOnlyError in interface CommonHandle

Parameters:

attribute - The read-only attribute.

expr - The expression whose value was attempted to be assigned to READ-ONLY attribute.

type

public java.lang.String type()

Get the type of this handle as type of String.

Returns:

See above.

instantiatingProcedure

public handle instantiatingProcedure()

Getter for the INSTANTIATING-PROCEDURE attribute.

The returned handle will refer a valid external procedure (persistent or not) or will be unknown, in case its instantiating procedure was persistent and has been deleted.

Specified by:

instantiatingProcedure in interface InstantiatingProcedure

Returns:

See above.

_instantiatingProcedure

public java.lang.Object _instantiatingProcedure()

Getter for the INSTANTIATING-PROCEDURE attribute, as direct resource.

The returned reference will refer the exact external procedure (persistent or not) or will be null, if instProc was not set.

Returns:

See above.

delete

public void delete()

Perform actual delete of an resource. At the time of this call, it is assumed the resource is valid for deletion (the handle and the resource are both valid).

The method first calls resourceDelete(), if the method returns false, the deletion is aborted.

Specified by:

delete in interface Deletable

incrementTrigger

public void incrementTrigger()

Increment the triggerRegistration counter.

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

addToPool

public void addToPool(character pool)

Add this resource to the WidgetPool.

Parameters:

pool - The pool name, set to null if the unnamed pool is to be used.

doDelete

protected void doDelete()

Perform actual delete of an resource. At the time of this call, it is assumed the resource is valid for deletion (the handle and the resource are both valid).

resourceDelete

protected boolean resourceDelete()

Worker to be implemented by each resource. Called by delete().

Returns:

true if the resource was deleted.

invalidAttribute

protected void invalidAttribute(java.lang.String attr,
                                boolean setter)

To be used only in cases a getter for a not-supported attribute is forced to be implemented by the resource. It displays appropriate error message.

Parameters:

attr - The not-supported attribute attribute.

setter - true for write access.

implicitDeletion

protected boolean implicitDeletion()

Check if the resource may be implicitly deleted.

Returns:

true if the resource's instantiating procedure is currently being deleted, and the resource is currently being processed.

setInstantiatingProcedure

protected void setInstantiatingProcedure(handle hproc)

Set the instantiating procedure for this resource.

Parameters:

hproc - The procedure where the resource was instantiated.

processResource

protected boolean processResource()

Check if this resource must be processed via ProcedureManager.processResource(com.goldencode.p2j.util.WrappedResource, boolean), once it has been instantiated.

Returns:

Always true.

unableToAssignUnknown

protected static void unableToAssignUnknown(java.lang.String attribute,
                                            java.lang.String widgetType)

Show an error complaining that the UNKNOWN value cannot be assigned to a specified attribute.

Parameters:

attribute - The targeted attribute.

widgetType - The widget type.