org.esa.beam.framework.datamodel
Class FlagCoding

java.lang.Object
  com.bc.ceres.core.ExtensibleObject
      org.esa.beam.framework.datamodel.ProductNode
          org.esa.beam.framework.datamodel.MetadataElement
              org.esa.beam.framework.datamodel.SampleCoding
                  org.esa.beam.framework.datamodel.FlagCoding

All Implemented Interfaces:

com.bc.ceres.core.Extensible

public class FlagCoding
extends SampleCoding

Provides the information required to decode integer sample values that are combined of single flags (bit indexes).

Field Summary

Fields inherited from class org.esa.beam.framework.datamodel.ProductNode

PROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_NAME

Constructor Summary

FlagCoding(String name)
Constructs a new flag coding object with the given name.

Method Summary

void	acceptVisitor(ProductVisitor visitor) Accepts the given visitor.
MetadataAttribute	addFlag(String name, int flagMask, String description) Adds a new flag definition to this flags coding.
MetadataAttribute	getFlag(String name) Returns a metadata attribute wich is the representation of the flag with the given name.
int	getFlagMask(String name) Returns the flag mask value for the specified flag name.
String[]	getFlagNames() Returns a string array which contains the names of all flags contained in this FlagCoding object.

Methods inherited from class org.esa.beam.framework.datamodel.SampleCoding

addAttribute, addElement, addSample, getSampleCount, getSampleName, getSampleValue

Methods inherited from class org.esa.beam.framework.datamodel.MetadataElement

addElementAt, containsAttribute, containsElement, createDeepClone, dispose, getAttribute, getAttributeAt, getAttributeDouble, getAttributeDouble, getAttributeIndex, getAttributeInt, getAttributeInt, getAttributeNames, getAttributes, getAttributeString, getAttributeString, getAttributeUTC, getAttributeUTC, getElement, getElementAt, getElementGroup, getElementIndex, getElementNames, getElements, getNumAttributes, getNumElements, getParentElement, getRawStorageSize, removeAttribute, removeElement, setAttributeDouble, setAttributeInt, setAttributeString, setAttributeUTC, setModified

Methods inherited from class org.esa.beam.framework.datamodel.ProductNode

fireProductNodeChanged, fireProductNodeChanged, getDescription, getDisplayName, getName, getOwner, getProduct, getProductReader, getProductReaderSafe, getProductRefString, getProductSafe, getProductWriter, getProductWriterSafe, getRawStorageSize, isModified, isPartOfSubset, isValidNodeName, removeFromFile, setDescription, setName, setOwner, toString, updateExpression

Methods inherited from class com.bc.ceres.core.ExtensibleObject

getExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FlagCoding

public FlagCoding(String name)

Constructs a new flag coding object with the given name.

Parameters:

name - the name

Method Detail

getFlag

public MetadataAttribute getFlag(String name)

Returns a metadata attribute wich is the representation of the flag with the given name. This method delegates to getPropertyValue(String).

Parameters:

name - the flag name

Returns:

a metadata attribute wich is the representation of the flag with the given name

getFlagNames

public String[] getFlagNames()

Returns a string array which contains the names of all flags contained in this FlagCoding object.

Returns:

a string array which contains all names of this FlagCoding.
If this FlagCoding does not contain any flag, null is returned

addFlag

public MetadataAttribute addFlag(String name,
                                 int flagMask,
                                 String description)

Adds a new flag definition to this flags coding.

Parameters:

name - the flag name

flagMask - the flag's bit mask

description - the description text

Returns:

A new attribute representing the flag.

Throws:

IllegalArgumentException - if name is null

getFlagMask

public int getFlagMask(String name)

Returns the flag mask value for the specified flag name.

Parameters:

name - the flag name

Returns:

flagMask the flag's bit mask as a 32 bit integer

Throws:

IllegalArgumentException - if name is null, or a flag with the name does not exist

acceptVisitor

public void acceptVisitor(ProductVisitor visitor)

Accepts the given visitor. This method implements the well known 'Visitor' design pattern of the gang-of-four. The visitor pattern allows to define new operations on the product data model without the need to add more code to it. The new operation is implemented by the visitor.

The method simply calls visitor.visit(this).

Overrides:

acceptVisitor in class MetadataElement

Parameters:

visitor - the visitor, must not be null