com.ge.research.acuity
Class AcuityConstants

java.lang.Object
  extended bycom.ge.research.acuity.AcuityConstants

public class AcuityConstants
extends java.lang.Object

This class provides methods for constructing unique user interface identification strings for presentation object parameters, as well as access to PresentationNatureConstants constants and methods, and PresentationParameterConstants constants and methods.

Version:
$Revision: 1.1 $ $Date: 2006/08/11 00:17:21 $
Author:
garbiras

Field Summary
static java.lang.String CLIENT_EFFECT_LANGUAGE
           
static java.lang.String CLIENT_EFFECT_LOCATION
           
static java.lang.String CLIENT_EFFECT_TYPE
           
static java.lang.String CLONE_PO
           
static java.lang.String CLONE_PROPERTY
           
static java.lang.String CLONE_VANTAGE
           
static java.lang.String CLONE_VANTAGE_PROPERTY
           
static java.lang.String CREATE_HLR
           
static boolean DEFAULT_PARAMETER_EDITABILITY
          The default editability of presentation object parameter editability by a user from a client application
static java.lang.String INTERACTIONOBJECT
          Constant value consistent with the type apvf:InteractionObject
static java.lang.String INVOKE_SCRIPT
           
static java.lang.String NAMESPACE_DELIMITER
          The delimiter for parsing fully qualified ontology type strings.
static java.lang.String PARAM_DELIMITER
          The delimiter for creating and parsing parameter identification strings for acuity clients.
static java.lang.String PRESENTATIONOBJECT
          Constant value consistent with the type apvf:PresentationObject
static java.lang.String PROCESS_FORM_CONTENT
           
static java.lang.String PROCESS_TABLE_CONTENT
           
static java.lang.String REMOVE_PO
           
static java.lang.String REMOVE_PROPERTY
           
static java.lang.String REMOVE_VANTAGE
           
static java.lang.String REMOVE_VANTAGE_PROPERTY
           
static java.lang.String SHARE_HLR
           
static java.lang.String URI_DELIMITER
          The delimiter that separates the ontology URI namespace from the ontology object local name.
 
Constructor Summary
AcuityConstants()
           
 
Method Summary
static java.lang.String getParameterString(PresentationObject po, java.lang.String param)
          Tries to get the subject for the param argument from the po PresentationObject.
static java.lang.String getParameterString(java.lang.String param)
          Creates an identification string for a parameter as the PARAM_DELIMITER string followed by the param string.
static java.lang.String getParameterString(java.lang.String name, java.lang.String param)
          If name is null, then returns the value from calling the getParameterString(java.lang.String) method.
static boolean isConstantValue(java.lang.String testCase)
          Tests to see if the supplied testcase is one of the ontology constants defined in this class or in PresentationNatureConstants or PresentationParameterConstants
static boolean isDataseriesType(java.lang.String testCase)
           
static boolean isGraphType(java.lang.String testCase)
           
static boolean isInteractionType(java.lang.String testCase)
           
static boolean isParameterUpdateRemembered(java.lang.String testCase)
           
static boolean isPresentationNature(java.lang.String testCase)
           
static boolean isPresentationParameter(java.lang.String testCase)
           
static boolean isReferenceType(java.lang.String testCase)
           
static boolean isSelectionType(java.lang.String testCase)
           
static boolean isTableType(java.lang.String testCase)
           
static boolean isTextInputType(java.lang.String testCase)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAMESPACE_DELIMITER

public static final java.lang.String NAMESPACE_DELIMITER
The delimiter for parsing fully qualified ontology type strings. The delimiter separates the ontology namespace prefix from the ontology type name.

See Also:
Constant Field Values

PARAM_DELIMITER

public static final java.lang.String PARAM_DELIMITER
The delimiter for creating and parsing parameter identification strings for acuity clients. The delimiter separates the parameter subject from the parameter name.

See Also:
Constant Field Values

URI_DELIMITER

public static final java.lang.String URI_DELIMITER
The delimiter that separates the ontology URI namespace from the ontology object local name.

See Also:
Constant Field Values

PRESENTATIONOBJECT

public static final java.lang.String PRESENTATIONOBJECT
Constant value consistent with the type apvf:PresentationObject

See Also:
Constant Field Values

INTERACTIONOBJECT

public static final java.lang.String INTERACTIONOBJECT
Constant value consistent with the type apvf:InteractionObject

See Also:
Constant Field Values

CLONE_PROPERTY

public static final java.lang.String CLONE_PROPERTY
See Also:
CloningIA.CLONE_PROPERTY, Constant Field Values

REMOVE_PROPERTY

public static final java.lang.String REMOVE_PROPERTY
See Also:
RemovalIA.REMOVE_PROPERTY, Constant Field Values

CLONE_PO

public static final java.lang.String CLONE_PO
See Also:
CloningIA.CLONE_PO, Constant Field Values

REMOVE_PO

public static final java.lang.String REMOVE_PO
See Also:
RemovalIA.REMOVE_PO, Constant Field Values

CLONE_VANTAGE_PROPERTY

public static final java.lang.String CLONE_VANTAGE_PROPERTY
See Also:
CloningIA.CLONE_VANTAGE_PROPERTY, Constant Field Values

REMOVE_VANTAGE_PROPERTY

public static final java.lang.String REMOVE_VANTAGE_PROPERTY
See Also:
RemovalIA.REMOVE_VANTAGE_PROPERTY, Constant Field Values

CLONE_VANTAGE

public static final java.lang.String CLONE_VANTAGE
See Also:
CloningIA.CLONE_VANTAGE, Constant Field Values

REMOVE_VANTAGE

public static final java.lang.String REMOVE_VANTAGE
See Also:
RemovalIA.REMOVE_VANTAGE, Constant Field Values

CREATE_HLR

public static final java.lang.String CREATE_HLR
See Also:
HighlightRegionIA.CREATE_HLR, Constant Field Values

SHARE_HLR

public static final java.lang.String SHARE_HLR
See Also:
HighlightRegionIA.SHARE_HLR, Constant Field Values

INVOKE_SCRIPT

public static final java.lang.String INVOKE_SCRIPT
See Also:
ScriptInvocationIA.INVOKE_SCRIPT, Constant Field Values

PROCESS_FORM_CONTENT

public static final java.lang.String PROCESS_FORM_CONTENT
See Also:
FormProcessingIA.PROCESS_FORM_CONTENT, Constant Field Values

PROCESS_TABLE_CONTENT

public static final java.lang.String PROCESS_TABLE_CONTENT
See Also:
TableInputProcessingIA.PROCESS_TABLE_CONTENT, Constant Field Values

DEFAULT_PARAMETER_EDITABILITY

public static final boolean DEFAULT_PARAMETER_EDITABILITY
The default editability of presentation object parameter editability by a user from a client application

See Also:
Constant Field Values

CLIENT_EFFECT_LOCATION

public static final java.lang.String CLIENT_EFFECT_LOCATION
See Also:
InteractionObject.CLIENT_EFFECT_LOCATION, Constant Field Values

CLIENT_EFFECT_TYPE

public static final java.lang.String CLIENT_EFFECT_TYPE
See Also:
InteractionObject.CLIENT_EFFECT_TYPE, Constant Field Values

CLIENT_EFFECT_LANGUAGE

public static final java.lang.String CLIENT_EFFECT_LANGUAGE
See Also:
InteractionObject.CLIENT_EFFECT_LANGUAGE, Constant Field Values
Constructor Detail

AcuityConstants

public AcuityConstants()
Method Detail

isConstantValue

public static final boolean isConstantValue(java.lang.String testCase)
Tests to see if the supplied testcase is one of the ontology constants defined in this class or in PresentationNatureConstants or PresentationParameterConstants

Parameters:
testCase - the string to test for existence as a constant value
Returns:
true if the testcase matches one of the constant values defined; false otherwise
See Also:
isPresentationNature(java.lang.String), isPresentationParameter(java.lang.String)

isParameterUpdateRemembered

public static final boolean isParameterUpdateRemembered(java.lang.String testCase)
See Also:
PresentationParameterConstants.isParameterUpdateRemembered(java.lang.String)

isPresentationNature

public static final boolean isPresentationNature(java.lang.String testCase)
See Also:
PresentationNatureConstants.isPresentationNature(java.lang.String)

isPresentationParameter

public static final boolean isPresentationParameter(java.lang.String testCase)
See Also:
PresentationParameterConstants.isPresentationParameter(java.lang.String)

isGraphType

public static final boolean isGraphType(java.lang.String testCase)
See Also:
PresentationNatureConstants.isGraphType(java.lang.String)

isDataseriesType

public static final boolean isDataseriesType(java.lang.String testCase)
See Also:
PresentationNatureConstants.isDataseriesType(java.lang.String)

isInteractionType

public static final boolean isInteractionType(java.lang.String testCase)
See Also:
PresentationNatureConstants.isInteractionType(java.lang.String)

isSelectionType

public static final boolean isSelectionType(java.lang.String testCase)
See Also:
PresentationNatureConstants.isSelectionType(java.lang.String)

isTableType

public static final boolean isTableType(java.lang.String testCase)
See Also:
PresentationNatureConstants.isTableType(java.lang.String)

isReferenceType

public static final boolean isReferenceType(java.lang.String testCase)
See Also:
PresentationNatureConstants.isReferenceType(java.lang.String)

isTextInputType

public static final boolean isTextInputType(java.lang.String testCase)
See Also:
PresentationNatureConstants.isTextInputType(java.lang.String)

getParameterString

public static final java.lang.String getParameterString(java.lang.String param)
Creates an identification string for a parameter as the PARAM_DELIMITER string followed by the param string.

Parameters:
param - the parameter to create an identification string for
Returns:
An identification string for the parameter
See Also:
PARAM_DELIMITER

getParameterString

public static final java.lang.String getParameterString(java.lang.String name,
                                                        java.lang.String param)
If name is null, then returns the value from calling the getParameterString(java.lang.String) method. Otherwise, prepends the name to the return value of the call to the getParameterString(java.lang.String) method.

Parameters:
name - the subject name for the parameter
param - the parameter to create an identification string for
Returns:
The unique identification string of the parameter for the given subject name
See Also:
getParameterString(java.lang.String)

getParameterString

public static final java.lang.String getParameterString(PresentationObject po,
                                                        java.lang.String param)
Tries to get the subject for the param argument from the po PresentationObject. Using that subject, calls the getParameterString(java.lang.String, java.lang.String) method. If the po argument is null, then it calls the getParameterString(java.lang.String) method.

Parameters:
po - the presentation object of the parameter
param - the parameter to create an identification string for
Returns:
The unique identification string of the parameter of the presentation object
See Also:
getParameterString(java.lang.String, java.lang.String), getParameterString(java.lang.String)