IMetadataEntry

All Superinterfaces:: Configurable, Findable, gda.observable.IObservable, Serializable

All Known Implementing Classes:: DateMetadataEntry, DummyMetadataEntry, EpicsMetadataEntry, ExternalCalibrationMetadataEntry, IcatMetadataEntry, JythonMetadataEntry, MetadataEntry, PersistantMetadataEntry, PropertyMetadataEntry, ScannableMetadataEntry, StoredMetadataEntry, StoredScanMetadataEntry, SubdirectoryMetadataEntry

public interface IMetadataEntry extends Findable, gda.observable.IObservable, Configurable, Serializable

Method Summary

Modifier and Type

Method

Description

boolean

canStoreValue()

String

getDefEntryName()

String

getMetadataValue()

Returns the current value of the object.

String

getName()

Gets the name of this metadata entry.

void

setDefEntryName(String defEntryName)

void

setName(String name)

Sets the name of this metadata entry.

void

setValue(String metadataValue)

Where appropriate, sets the value of the metadata.

Methods inherited from interface gda.factory.Configurable
configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.observable.IObservable
addIObserver, deleteIObserver, deleteIObservers

Method Details
- getMetadataValue
  
  String getMetadataValue()
  
  Returns the current value of the object. The method of retrieving this value will vary depending on the type of this piece of metadata.
  
  Returns:
  
  The value of this metadata entry.
- setName
  
  void setName(String name)
  
  Sets the name of this metadata entry.
  
  Specified by:
  
  setName in interface Findable
  
  Parameters:
  
  name - The name of the metadata entry.
- getName
  
  String getName()
  
  Gets the name of this metadata entry.
  
  Specified by:
  
  getName in interface Findable
  
  Returns:
  
  The name of this metadata entry.
- getDefEntryName
  
  String getDefEntryName()
  
  Returns:
  
  defEntryName
- setDefEntryName
  
  void setDefEntryName(String defEntryName)
  
  Parameters:
  
  defEntryName -
- setValue
  
  void setValue(String metadataValue) throws Exception
  
  Where appropriate, sets the value of the metadata.
  
  Parameters:
  
  metadataValue -
  
  Throws:
  
  Exception
- canStoreValue
  
  boolean canStoreValue()
  
  Returns:
  
  true - if this instance of IMetadataEntry can persist its value, so the storeValue method will try to do something