edu.nrao.sss.model.source.parser
Enum SourceCatalogTextFormat

java.lang.Object
  java.lang.Enum<SourceCatalogTextFormat>
      edu.nrao.sss.model.source.parser.SourceCatalogTextFormat

All Implemented Interfaces:

Serializable, Comparable<SourceCatalogTextFormat>

public enum SourceCatalogTextFormat
extends Enum<SourceCatalogTextFormat>

Text formats for the import and export of a source catalog.

Version Info:

$Revision: 877 $

$Date: 2007-09-18 11:02:30 -0600 (Tue, 18 Sep 2007) $

$Author: jrochfor $

Since:

2007-05-16

Author:

David M. Harland

Enum Constant Summary

GBT

PST

VLA

VLBA

XML

Method Summary

boolean	isExportSupported() Returns true if the export of a catalog into this text format is supported.
boolean	isImportSupported() Returns true if the import of a catalog from this text format is supported.
abstract SourceCatalogReader	makeNewReader() Returns a new source catalog reader that understands this format.
abstract SourceCatalogWriter	makeNewWriter() Returns a new source catalog writer that understands this format.
void	setExportSupported(boolean isSupported) Configures this format to either support, or not support, the export of a source catalog into this type of text.
void	setImportSupported(boolean isSupported) Configures this format to either support, or not support, the import of a source catalog from this type of text.
String	toString() Returns a text representation of this enumeration constant.
static SourceCatalogTextFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static SourceCatalogTextFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML

public static final SourceCatalogTextFormat XML

VLA

public static final SourceCatalogTextFormat VLA

VLBA

public static final SourceCatalogTextFormat VLBA

GBT

public static final SourceCatalogTextFormat GBT

PST

public static final SourceCatalogTextFormat PST

Method Detail

values

public static SourceCatalogTextFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SourceCatalogTextFormat c : SourceCatalogTextFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SourceCatalogTextFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

setImportSupported

public void setImportSupported(boolean isSupported)

Configures this format to either support, or not support, the import of a source catalog from this type of text.

Parameters:

isSupported - true if the import of this format should be supported.

setExportSupported

public void setExportSupported(boolean isSupported)

Configures this format to either support, or not support, the export of a source catalog into this type of text.

Parameters:

isSupported - true if the export of this format should be supported.

isImportSupported

public boolean isImportSupported()

Returns true if the import of a catalog from this text format is supported.

Returns:

true if the import of a catalog from this text format is supported.

isExportSupported

public boolean isExportSupported()

Returns true if the export of a catalog into this text format is supported.

Returns:

true if the export of a catalog into this text format is supported.

makeNewReader

public abstract SourceCatalogReader makeNewReader()

Returns a new source catalog reader that understands this format.

Returns:

a new source catalog reader that understands this format. May return null if reading is not supported.

makeNewWriter

public abstract SourceCatalogWriter makeNewWriter()

Returns a new source catalog writer that understands this format.

Returns:

a new source catalog writer that understands this format. May return null if writing is not supported.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<SourceCatalogTextFormat>

Returns:

a text representation of this enumeration constant.