DataOperand (Unidata IDV API v6.0)

java.lang.Object
- ucar.unidata.data.DataOperand

```
public class DataOperand
extends java.lang.Object
```
This class holds a name/value pair that represents an operand for the DerivedDataChoice

Version:

$Revision: 1.16 $

Author:

IDV development team

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String PROP_LEVEL
The level property

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_LEVEL` The level property

Constructor Summary

Constructors
Constructor and Description
`DataOperand(java.lang.String name)` Create a new DataOperand with null data
`DataOperand(java.lang.String name, java.lang.Object data)` Create a new DataOperand
`DataOperand(java.lang.String name, java.lang.String description, java.util.List categories, boolean multiple)` ctor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Check to see if the object in question is equal to this.
`java.util.List`	`getCategories()` Get the list of `DataCategory`s that are defined by the categories property
`java.lang.Object`	`getData()` Get the data.
`java.lang.String`	`getDataSourceName()` DOes this operand have a datasource property
`java.lang.String`	`getDescription()` Get the description from the properties
`java.lang.String`	`getLabel()` Get the name used for the label in the gui
`boolean`	`getMultiple()` Get the multiple property
`java.lang.String`	`getName()` Get the name.
`java.lang.String`	`getParamName()` Get just the param name, strip off the categories
`java.lang.String`	`getPattern()` Get the pattern from the properties
`java.lang.String`	`getProperty(java.lang.String name)` Get the named property
`java.util.List`	`getTimeIndices()` Get the list of time (Integer) indices defined with the times property
`java.lang.String`	`getUserDefault()` Get the default user value
`int`	`hashCode()` Return the hashcode for this DataOperand.
`boolean`	`isBound()` See if this a bound operand or not (has data)
`boolean`	`isPersistent()` Is this operand persistent
`boolean`	`isUser()` Is this operand an end user defined value
`static void`	`main(java.lang.String[] argv)` Test
`java.lang.String`	`makeLegalJython()` Remove all of the special IDV characters in the given jython operand.
`void`	`putCategories(java.util.List categories)` Set the categories
`void`	`putDescription(java.lang.String desc)` Put the description in the properties
`void`	`putMultiple(boolean b)` Put the multiple property
`void`	`putPattern(java.lang.String pattern)` Put the pattern into the properties
`void`	`setData(java.lang.Object value)` Set the data.
`void`	`setName(java.lang.String value)` Set the name.
`java.lang.String`	`toString()` Return a string representation of this DataOperand.

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

- Field Detail
  - PROP_LEVEL
```
public static final java.lang.String PROP_LEVEL
```
    The level property
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataOperand
```
public DataOperand(java.lang.String name)
```
    Create a new DataOperand with null data
    
    Parameters:
    
    name - name for this object
  - DataOperand
```
public DataOperand(java.lang.String name,
                   java.lang.Object data)
```
    Create a new DataOperand
    
    Parameters:
    
    name - name for this object
    
    data - associated data
  - DataOperand
```
public DataOperand(java.lang.String name,
                   java.lang.String description,
                   java.util.List categories,
                   boolean multiple)
```
    ctor
    
    Parameters:
    
    name - name
    
    description - description
    
    categories - categories
    
    multiple - supports multiples
- Method Detail
  - putDescription
```
public void putDescription(java.lang.String desc)
```
    Put the description in the properties
    
    Parameters:
    
    desc - description
  - getDescription
```
public java.lang.String getDescription()
```
    Get the description from the properties
    
    Returns:
    
    description
  - putPattern
```
public void putPattern(java.lang.String pattern)
```
    Put the pattern into the properties
    
    Parameters:
    
    pattern - the pattern
  - getPattern
```
public java.lang.String getPattern()
```
    Get the pattern from the properties
    
    Returns:
    
    the pattern
  - equals
```
public boolean equals(java.lang.Object o)
```
    Check to see if the object in question is equal to this.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - Object in question
    
    Returns:
    
    true if they are equal
  - hashCode
```
public int hashCode()
```
    Return the hashcode for this DataOperand.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hashcode
  - toString
```
public java.lang.String toString()
```
    Return a string representation of this DataOperand.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of this DataOperand
  - putCategories
```
public void putCategories(java.util.List categories)
```
    Set the categories
    
    Parameters:
    
    categories - catgegories
  - getCategories
```
public java.util.List getCategories()
```
    Get the list of DataCategorys that are defined by the categories property
    
    Returns:
    
    List of data categories or null if none defined
  - setName
```
public void setName(java.lang.String value)
```
    Set the name. (Used by XML persistence)
    
    Parameters:
    
    value - name for this object
  - getName
```
public java.lang.String getName()
```
    Get the name. (Used by XML persistence)
    
    Returns:
    
    this object's name
  - setData
```
public void setData(java.lang.Object value)
```
    Set the data. (Used by XML persistence)
    
    Parameters:
    
    value - the data
  - getData
```
public java.lang.Object getData()
```
    Get the data. (Used by XML persistence)
    
    Returns:
    
    the data
  - isBound
```
public boolean isBound()
```
    See if this a bound operand or not (has data)
    
    Returns:
    
    true if data is not null
  - putMultiple
```
public void putMultiple(boolean b)
```
    Put the multiple property
    
    Parameters:
    
    b - multiple
  - getMultiple
```
public boolean getMultiple()
```
    Get the multiple property
    
    Returns:
    
    multiple
  - isPersistent
```
public boolean isPersistent()
```
    Is this operand persistent
    
    Returns:
    
    is persistent
  - isUser
```
public boolean isUser()
```
    Is this operand an end user defined value
    
    Returns:
    
    Is define dby the user
  - getDataSourceName
```
public java.lang.String getDataSourceName()
```
    DOes this operand have a datasource property
    
    Returns:
    
    The data source property
  - getUserDefault
```
public java.lang.String getUserDefault()
```
    Get the default user value
    
    Returns:
    
    The default for user specified values
  - getProperty
```
public java.lang.String getProperty(java.lang.String name)
```
    Get the named property
    
    Parameters:
    
    name - property name
    
    Returns:
    
    The property
  - getParamName
```
public java.lang.String getParamName()
```
    Get just the param name, strip off the categories
    
    Returns:
    
    The param name
  - getLabel
```
public java.lang.String getLabel()
```
    Get the name used for the label in the gui
    
    Returns:
    
    The label.
  - makeLegalJython
```
public java.lang.String makeLegalJython()
```
    Remove all of the special IDV characters in the given jython operand.
    
    Returns:
    
    cleaned up operand
  - getTimeIndices
```
public java.util.List getTimeIndices()
```
    Get the list of time (Integer) indices defined with the times property
    
    Returns:
    
    Listof time indices or null
  - main
```
public static void main(java.lang.String[] argv)
```
    Test
    
    Parameters:
    
    argv - Cmd line args

Class DataOperand

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_LEVEL

Constructor Detail

DataOperand

DataOperand

DataOperand

Method Detail

putDescription

getDescription

putPattern

getPattern

equals

hashCode

toString

putCategories

getCategories

setName

getName

setData

getData

isBound

putMultiple

getMultiple

isPersistent

isUser

getDataSourceName

getUserDefault

getProperty

getParamName

getLabel

makeLegalJython

getTimeIndices

main