EditableHeader (Mango Plugin API)

All Superinterfaces:

MangoPluginType
```
public interface EditableHeader
extends MangoPluginType
```
An EditableHeader is a header with editable fields.

Author:

michaelmartinez

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class EditableHeader.CodeOption
A CodeOption consists of a code string and human-readable name.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`EditableHeader.CodeOption` A CodeOption consists of a code string and human-readable name.

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,List<String>>`	`anonymize()` Perform anonymization.
`List<String>`	`getAnonymizableFields()` Returns a list of anonymizable fields or null if anonymization is not supported.
`Map<String,List<String>>`	`getEditableFieldValues()` Returns a map of field names to field values.
`Map<String,List<EditableHeader.CodeOption>>`	`getHumanReadableFieldOptions()` Returns a map of field names to lists of human readable code names.
`boolean`	`isTextEditableHeader()` Returns true if this header is text-editable.
`void`	`setEditableFieldValue(String name, String value, int index)` Sets a header field.
`void`	`writeHeader()` Write out the header.

Methods inherited from interface edu.uthscsa.ric.mango.MangoPluginType
getMinimumVersionSupported, getPluginName, getPluginURL, getVersion, hasNewerVersion

- Method Detail
  - getEditableFieldValues
```
Map<String,List<String>> getEditableFieldValues()
```
    Returns a map of field names to field values. For example, one map element may be "Datatype" : List [datatype]. Another example, "Dimensions" : List [xDim, yDim, zDim].
    
    Returns:
    a map of field names to lists of field values
  - getHumanReadableFieldOptions
```
Map<String,List<EditableHeader.CodeOption>> getHumanReadableFieldOptions()
```
    Returns a map of field names to lists of human readable code names. For example, one map element may be "Datatype" : List[CodeOption(0,"Unknown"), CodeOption(1,"8-bit Integer"), CodeOption(2,"32-bit Float")].
    
    Returns:
    a map of field names to lists of human readable code names
  - isTextEditableHeader
```
boolean isTextEditableHeader()
```
    Returns true if this header is text-editable. If so, implementation of getEditableFieldValues() is not necessary.
    
    Returns:
    true if this header is text-editable, false otherwise
  - setEditableFieldValue
```
void setEditableFieldValue(String name,
                         String value,
                         int index)
```
    Sets a header field.
    
    Parameters:
    name - the field name
    value - the field value
    index - the field index [this would correspond to the list index used in getEditableFieldValues()]
  - getAnonymizableFields
```
List<String> getAnonymizableFields()
```
    Returns a list of anonymizable fields or null if anonymization is not supported.
    
    Returns:
    a list of anonymizable fields or null
  - anonymize
```
Map<String,List<String>> anonymize()
```
    Perform anonymization. Returns a map of field names to field values.
    
    Returns:
    a map of field names to field values
  - writeHeader
```
void writeHeader()
```
    Write out the header.

Interface EditableHeader

Nested Class Summary

Method Summary

Methods inherited from interface edu.uthscsa.ric.mango.MangoPluginType

Method Detail

getEditableFieldValues

getHumanReadableFieldOptions

isTextEditableHeader

setEditableFieldValue

getAnonymizableFields

anonymize

writeHeader