VizEntry

java.lang.Object
- org.eclipse.eavp.viz.datastructures.VizObject.VizObject
- - org.eclipse.eavp.viz.datastructures.VizEntry

All Implemented Interfaces:

IVizObject, IVizUpdateable

Direct Known Subclasses:

KeyEntry, PortEntry, SecretEntry, TestEntry
```
public class VizEntry
extends VizObject
implements IVizUpdateable
```
The Entry class is responsible for collecting and managing the individual values needed by the Item to perform a task. The Entry class is capable of checking bounds and validity.

The Entry's content will be maintained by a content provider, or any piece that respectfully inherits from the IEntryContentProvider. All of the getters and setters for the content (AllowedValues, type, default values, etc) will pull from the ContentProvider. If the nullary constructor is used, then the Entry will create the BasicEntryContentProvider. Entry.Value and attributes like changedState, on the other hand, will be managed specifically by Entry (this excludes default value).

The "readiness" of an Entry is used map dependencies between Entries and other Entries. An Entry may depend on a parent Entry and passing the correct key-value pair to the update() operation will mark the Entry as ready or not ready depending on the state of the parent. All Entries default to ready. The changed or modified state of the Entry is similar in that it distinguishes whether or not an Entry has been recently modified.

The Entry implements IUpdateable to update the state of the Entry based on key-value pairs. The base default implementation of update() will mark the Entry as "ready" (isReady() will return true) if the name of the Entry's parent is passed as the key and one of "ready," "yes," "y," "on," "true" or "enabled" is passed as the value (minus the commas of course). It will mark the Entry as not ready (isReady() will return false) if the value is "not ready," "no," "n," "off," "false" or "disabled" instead. Neither set of values are case sensitive ("Yes" will work as well as "yes"). It also resets the "changed" state of the Entry to false to reflect that review is required because of new information from the update. This operation should be overridden by subclasses to get tailored update behavior, but Entry.update should be called still (by using "super.update()") to handle updating because of parents and setting the changed state.

IComponentListeners can also registered with the Entry since it implements IUpdateable. The Entry will notify listeners when its value changes.

Managing the readiness of the Entry with update in the base class allows ICE to generically handle the almost trivial case of dependencies where one Entry needs to know about the state of another before revealing itself.

The Entry can also be marked as "secret" to indicate that its contents should not be displayed openly. Entries should be marked secret in their setup() operation. There is no public operation to mark them as secret, although there is an isSecret() operation to determine whether or not an Entry is secret.

Entry's may be "tagged" with values that act as secondary names or unique identifiers in systems outside of ICE. This is particularly useful for creating files based on key-value pairs of Entry names and values, but the name of the Entry needs to be some condensed or modified form of the human readable name returned by getName().

Entry is a subclass of ICEObject. It overrides ICEObject.copy(), ICEObject.clone() as specified and required by the ICEObject class.

Giving one Entry priority over another can be done in a couple of different ways. The first way is to set an Entry's required flag to true (c.f. setRequired()). Entries can also be organized based on their identification number. If an Entry is marked as "required" it should be treated as if it is required for computation and prioritized higher than others that are not required.

Author:

Jay Jay Billings, Anna Wojtowicz

Field Summary
- Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable
  iComponentListener

Constructor Summary

Constructors
Constructor and Description
`VizEntry()` A convenience function which calls the constructor configured to run setup()
`VizEntry(boolean runSetup)` A constructor that will create an Entry with only a unique ID and a name.
`VizEntry(IVizEntryContentProvider contentProvider)` A constructor that sets the entry to the content provider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` This operation provides a deep copy of the Entry.
`void`	`copy(VizEntry otherEntry)` This operation performs a deep copy of the attributes of another Entry into the current Entry.
`boolean`	`equals(java.lang.Object otherEntry)` This method is used to check equality between the Entry and another Entry.
`java.util.ArrayList<java.lang.String>`	`getAllowedValues()` This Entry returns the allowed values for the Entry and should only be used when the AllowedValueType is defined as Discrete, in which case the value must equal one of the allowed values.
`java.lang.String`	`getComment()` Get the value of the Entry's comment.
`java.lang.String`	`getDefaultValue()` This operation returns the default value of the Entry.
`java.lang.String`	`getErrorMessage()` This operation returns a human-readable reason for a rejected value passed to setValue().
`java.lang.String`	`getParent()` This operation retrieves the name of the Entry on which this Entry is dependent.
`java.lang.String`	`getTag()` This operation returns the Entry's tag.
`java.lang.String`	`getValue()` This operation returns the current value of the Entry or the default value if no other has been specified.
`VizAllowedValueType`	`getValueType()` This operation returns the type of value that is stored in the Entry.
`int`	`hashCode()` This operation returns the hashcode value of the Entry.
`boolean`	`isModified()` This operation returns true if the Entry's value was recently set and false if the Entry's value has not been changed or if the Entry was recently updated.
`boolean`	`isReady()` This operation returns true if the Entry should be addressed and false if the Entry is not ready to be addressed (waiting on a parent Entry, etc.).
`boolean`	`isRequired()` This operation returns true if the Entry should be treated as a required quantity.
`boolean`	`isSecret()` This operation returns true if the Entry is "secret" and its contents should be obscured if displayed or printed and false if not.
`void`	`setComment(java.lang.String comment)` Set the comment on the Entry.
`void`	`setContentProvider(IVizEntryContentProvider contentProvider)` Sets the content provider.
`void`	`setParent(java.lang.String parentName)` This operation stores the name of an Entry on which this Entry is dependent.
`void`	`setReady(boolean isReady)` This operation sets the readiness state of the Entry to the value of isReady.
`void`	`setRequired(boolean entryRequired)` This operation sets the marks the Entry as required or not to indicate where or not it should be treated as a required quantity.
`void`	`setTag(java.lang.String tagValue)` This operation sets the tag of the Entry.
`boolean`	`setValue(java.lang.String newValue)` This operation sets the value of the Entry to newValue and returns true if it is successful.
`void`	`update(java.lang.String updatedKey, java.lang.String newValue)` (non-Javadoc)

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizObject.VizObject
copy, getDescription, getId, getName, register, setDescription, setId, setName, unregister

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable
register, unregister

- Constructor Detail
  - VizEntry
```
public VizEntry()
```
    A convenience function which calls the constructor configured to run setup()
  - VizEntry
```
public VizEntry(boolean runSetup)
```
    A constructor that will create an Entry with only a unique ID and a name. Default values are set:
    - objectDescription = "Entry" + uniqueId
    - defaultValue = ""
    - allowedValues = null
    - allowedValueType = AllowedValueType.Undefined
    The constructor may optionally call the setup function after setting the default values. The setup function can be overridden to tailor the properties of the Entry or otherwise overload the behavior of the Entry. Not invoking startup is desirable when the user will invoke it themselves at a later point, such as when another constructor calls this one before completing the object's initialization itself.
    Parameters:
    
    runSetup - Whether or not to run the setup() function
  - VizEntry
```
public VizEntry(IVizEntryContentProvider contentProvider)
```
    A constructor that sets the entry to the content provider.
    
    Parameters:
    
    contentProvider -
- Method Detail
  - getAllowedValues
```
public java.util.ArrayList<java.lang.String> getAllowedValues()
```
    This Entry returns the allowed values for the Entry and should only be used when the AllowedValueType is defined as Discrete, in which case the value must equal one of the allowed values. These allowed values types should not be used to check the submitted value because the Entry class will handle its own error checking upon the submission of a value in setValue().
    
    Returns:
    
    The allowed values for the Entry.
  - getDefaultValue
```
public java.lang.String getDefaultValue()
```
    This operation returns the default value of the Entry.
    
    Returns:
    
    The default value of the Entry.
  - getValue
```
public java.lang.String getValue()
```
    This operation returns the current value of the Entry or the default value if no other has been specified.
    
    Returns:
    
    The current value of the Entry.
  - getValueType
```
public VizAllowedValueType getValueType()
```
    This operation returns the type of value that is stored in the Entry.
    
    A response type of AllowedValueType.Discrete means that the answer must be one of the values from getAllowedValues().
    
    A response of AllowedValueTypes.Continuous means that the value must exist within the range of the maximum and minimum of the values from getAllowedValues().
    
    A response of AllowedValueType.Undefined means that the response will not be checked.
    
    A response of AllowedValueType.File means that the response will not be checked just like an Undefined type, but should only be used for values that represent actual files. File entries render differently in the UI.
    
    Please note that the Entry class will check the validity of the values submitted to it and the information returned from this method is purely for information purposes (deciding how to draw the client, etc.).
    
    Returns:
    
    The AllowedValueType for the Entry.
  - setComment
```
public void setComment(java.lang.String comment)
```
    Set the comment on the Entry. Empty strings are permitted.
    
    Parameters:
    
    comment - The comment to set on the Entry.
  - getComment
```
public java.lang.String getComment()
```
    Get the value of the Entry's comment.
    
    Returns:
    
    The comment.
  - isReady
```
public boolean isReady()
```
    This operation returns true if the Entry should be addressed and false if the Entry is not ready to be addressed (waiting on a parent Entry, etc.).
    
    Returns:
    
    The readiness state of the Entry.
  - isModified
```
public boolean isModified()
```
    This operation returns true if the Entry's value was recently set and false if the Entry's value has not been changed or if the Entry was recently updated.
    
    Returns:
    
    True if the Entry's value was recently set, false if the Entry's value has not been set or if the Entry was recently updated.
  - setParent
```
public void setParent(java.lang.String parentName)
```
    This operation stores the name of an Entry on which this Entry is dependent. The "parent" Entry must be evaluated and notify this Entry by calling update() before this Entry will mark itself as ready.
    
    Parameters:
    
    parentName - The name of the parent Entry.
  - getParent
```
public java.lang.String getParent()
```
    This operation retrieves the name of the Entry on which this Entry is dependent. The "parent" Entry must be evaluated and notify this Entry by calling update() before this Entry will mark itself as ready.
    
    Returns:
    
    The name of the parent Entry.
  - setValue
```
public boolean setValue(java.lang.String newValue)
```
    This operation sets the value of the Entry to newValue and returns true if it is successful.
    
    Parameters:
    
    newValue - The new value of the Entry. This value will be checked by the Entry for validity.
    
    Returns:
    
    True if setValue worked, false otherwise.
  - setReady
```
public void setReady(boolean isReady)
```
    This operation sets the readiness state of the Entry to the value of isReady.
    
    Parameters:
    
    isReady - The value to which the readiness state of the Entry should be set.
  - update
```
public void update(java.lang.String updatedKey,
                   java.lang.String newValue)
```
    Description copied from class: VizObject
    
    (non-Javadoc)
    
    Specified by:
    
    update in interface IVizObject
    
    Specified by:
    
    update in interface IVizUpdateable
    
    Overrides:
    
    update in class VizObject
    
    Parameters:
    
    updatedKey -
    A unique key that describes the value that to be updated.
    
    newValue -
    The updated value of the key.
    
    See Also:
    
    IUpdateable#update(String updatedKey, String newValue)
  - equals
```
public boolean equals(java.lang.Object otherEntry)
```
    This method is used to check equality between the Entry and another Entry. It returns true if the Entries are equal and false if they are not.
    
    Specified by:
    
    equals in interface IVizObject
    
    Overrides:
    
    equals in class VizObject
    
    Parameters:
    
    otherEntry - The Entry that should be checked for equality.
    
    Returns:
    
    True if the Entries are equal, false if not
    
    See Also:
    
    Identifiable#equals(Object otherObject)
  - hashCode
```
public int hashCode()
```
    This operation returns the hashcode value of the Entry.
    
    Specified by:
    
    hashCode in interface IVizObject
    
    Overrides:
    
    hashCode in class VizObject
    
    Returns:
    
    The hashcode
    
    See Also:
    
    Identifiable#hashCode()
  - isSecret
```
public boolean isSecret()
```
    This operation returns true if the Entry is "secret" and its contents should be obscured if displayed or printed and false if not.
    
    Returns:
    
    True if the entry is "secret", false otherwise.
  - copy
```
public void copy(VizEntry otherEntry)
```
    This operation performs a deep copy of the attributes of another Entry into the current Entry.
    
    Parameters:
    
    otherEntry - The Entry from which information should be copied.
  - clone
```
public java.lang.Object clone()
```
    This operation provides a deep copy of the Entry.
    
    Specified by:
    
    clone in interface IVizObject
    
    Overrides:
    
    clone in class VizObject
    
    Returns:
    
    A clone of the Entry.
  - getTag
```
public java.lang.String getTag()
```
    This operation returns the Entry's tag.
    
    Returns:
    
    The Entry's tag.
  - setTag
```
public void setTag(java.lang.String tagValue)
```
    This operation sets the tag of the Entry.
    
    Parameters:
    
    tagValue - The Entry's new tag.
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    This operation returns a human-readable reason for a rejected value passed to setValue().
    Returns:
    The error message. If the AllowedValueType of the Entry is Continuous, it will be an error of the form:
    
    '${incorrectValue}' in an unacceptable value. The value must be between ${lowerBound} and ${upperBound}.
    
    If the AllowedValueType is Discrete, it will be an error of the form:
    
    '${incorrectValue}' in an unacceptable value. The value must be one of ${allowedValues}.
    
    The variables are:
    
    ${incorrectValue} - The incorrect value submitted to setValue()
    
    ${lowerBound} - The lower bound of the range
    
    ${upperBound} - The upper bound of the range
    
    ${allowedValue} - The entire set of allowed values for AllowedValueType.Discrete.
    
    An error message will never be posted if the type is AllowedValueType.Undefined and this value will be null.
    
    If the value of setValue() was accepted, this operation will return null.
  - setContentProvider
```
public void setContentProvider(IVizEntryContentProvider contentProvider)
```
    Sets the content provider. Resets the value to null.
    
    Parameters:
    
    contentProvider - The content provider.
  - isRequired
```
public boolean isRequired()
```
    This operation returns true if the Entry should be treated as a required quantity.
    
    Returns:
    
    True if required, false if not.
  - setRequired
```
public void setRequired(boolean entryRequired)
```
    This operation sets the marks the Entry as required or not to indicate where or not it should be treated as a required quantity.
    
    Parameters:
    
    entryRequired - The value to which the required state of the Entry should be set; true if required, false if not.

Class VizEntry

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizObject.VizObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

Constructor Detail

VizEntry

VizEntry

VizEntry

Method Detail

getAllowedValues

getDefaultValue

getValue

getValueType

setComment

getComment

isReady

isModified

setParent

getParent

setValue

setReady

update

equals

hashCode

isSecret

copy

clone

getTag

setTag

getErrorMessage

setContentProvider

isRequired

setRequired