# Index

A B C D E F G H I J L M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

## A

ALLOW_FCG_PROPERTIES - Static variable in class uk.ac.starlink.tfcat.Decoders
  If set true, the "properties" member is permitted on FeatureCollection and Geometry objects, in contravention of Section 7.1 of the GeoJSON spec RFC7946.

## B

BasicReporter - Class in uk.ac.starlink.tfcat
  Standard reporter implementation.
BasicReporter(boolean) - Constructor for class uk.ac.starlink.tfcat.BasicReporter
  Constructs a BasicReporter with no UCD or VOUnit validation.
BasicReporter(boolean, WordChecker, WordChecker) - Constructor for class uk.ac.starlink.tfcat.BasicReporter
  Constructs a BasicReporter with configurable UCD and VOUnit validation.
Bbox - Class in uk.ac.starlink.tfcat
  Represents a TFCat bbox (bounding box) structure.
Bbox(double, double, double, double) - Constructor for class uk.ac.starlink.tfcat.Bbox
  Constructor.
BBOX - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a Bbox object.
BOOL - Static variable in class uk.ac.starlink.tfcat.Datatype
  Boolean type.

## C

CDF_TT2000 - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Predefined TimeCoords instance for CDF Epoch TT2000.
checkBoundingBoxes(Reporter, TfcatObject) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Performs a global check for a given TfcatObject that any positions listed are within the bounding boxes in whose scope they appear.
checkCrs(Reporter, TfcatObject) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Ensure that CRS objects are in place for the tree rooted at the given TFCat Object.
checkOption(Reporter, String, Collection<String>) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Checks whether a given token is in a supplied list of valid options.
checkUcd(String) - Method in class uk.ac.starlink.tfcat.BasicReporter
checkUcd(String) - Method in class uk.ac.starlink.tfcat.DummyReporter
checkUcd(String) - Method in interface uk.ac.starlink.tfcat.Reporter
  Report on validity of the supplied Uniform Content Descriptor.
checkUnit(String) - Method in class uk.ac.starlink.tfcat.BasicReporter
checkUnit(String) - Method in class uk.ac.starlink.tfcat.DummyReporter
checkUnit(String) - Method in interface uk.ac.starlink.tfcat.Reporter
  Report on validity of the supplied unit string.
checkWord(String) - Method in interface uk.ac.starlink.tfcat.WordChecker
  Reports warnings or errors associated with a supplied string.
createReporter(int) - Method in class uk.ac.starlink.tfcat.BasicReporter
createReporter(int) - Method in class uk.ac.starlink.tfcat.DummyReporter
createReporter(int) - Method in interface uk.ac.starlink.tfcat.Reporter
  Returns a reporter suitable for use in a subcontext characterised by an integer, that usually means an indexed array element below the current level.
createReporter(String) - Method in class uk.ac.starlink.tfcat.BasicReporter
createReporter(String) - Method in class uk.ac.starlink.tfcat.DummyReporter
createReporter(String) - Method in interface uk.ac.starlink.tfcat.Reporter
  Returns a reporter suitable for use in a subcontext characterised by a string, that usually means a level down in the object hierarchy.
Crs - Interface in uk.ac.starlink.tfcat
  Coordinate Reference System.
CRS - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a CRS object.

## D

Datatype<T> - Class in uk.ac.starlink.tfcat
  Characterises the type of data held by a field.
DATATYPE - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a DataType object.
decode(String) - Method in class uk.ac.starlink.tfcat.Datatype
  Decodes a string value that has this type.
decode(Reporter, Object, TfcatObject) - Method in interface uk.ac.starlink.tfcat.Decoder
  Takes a parsed JSON object (may be an array or something else) and attempts to decode it into an object of this decoder's parameterised type.
Decoder<T> - Interface in uk.ac.starlink.tfcat
  Turns a JSON object into a typed java object.
Decoders - Class in uk.ac.starlink.tfcat
  Contains decoder implementations for all the TFCat types.
DummyReporter - Class in uk.ac.starlink.tfcat
  Reporter that discards all messages.
DummyReporter() - Constructor for class uk.ac.starlink.tfcat.DummyReporter
  Constructor.

## E

equals(Object) - Method in class uk.ac.starlink.tfcat.Position

## F

FAIL - Enum constant in enum class uk.ac.starlink.tfcat.TfcatStatus.Code
  Fatal errors encounted during parse, no TFCat object constructed.
Feature - Class in uk.ac.starlink.tfcat
  Represents a TFCat Feature object.
Feature(JSONObject, Crs, Bbox, Geometry<?>, String, JSONObject) - Constructor for class uk.ac.starlink.tfcat.Feature
  Constructor.
FEATURE - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a Feature object.
FEATURE_COLLECTION - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a FeatureCollection object.
FeatureCollection - Class in uk.ac.starlink.tfcat
  Represents a TFCat FeatureCollection object.
FeatureCollection(JSONObject, Crs, Bbox, Map<String, Field>, Feature[]) - Constructor for class uk.ac.starlink.tfcat.FeatureCollection
  Constructor.
Field - Interface in uk.ac.starlink.tfcat
  Represents a TFCat Field.
FIELDS - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for an array of Field objects.
FLOAT - Static variable in class uk.ac.starlink.tfcat.Datatype
  Floating point type.
forName(String) - Static method in class uk.ac.starlink.tfcat.Datatype
  Returns the datatype instance for a given type name.

## G

GEOMETRIES - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a GeometryCollection.
Geometry<S> - Class in uk.ac.starlink.tfcat
  Abstract superclass representing one of the seven typed Geometry objects defined in the TFCat specification.
GEOMETRY - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a Geometry object.
Geometry.GeometryCollection - Class in uk.ac.starlink.tfcat
  Geometry subclass representing a TFCat GeometryCollection.
Geometry.LineString - Class in uk.ac.starlink.tfcat
  Geometry subclass representing a TFCat LineString.
Geometry.MultiLineString - Class in uk.ac.starlink.tfcat
  Geometry subclass representing a TFCat MultiLineString.
Geometry.MultiPoint - Class in uk.ac.starlink.tfcat
  Geometry subclass representing a TFCat MultiPoint.
Geometry.MultiPolygon - Class in uk.ac.starlink.tfcat
  Geometry subclass representing a TFCat MultiPolygon.
Geometry.Point - Class in uk.ac.starlink.tfcat
  Geometry subclass representing a TFCat Point.
Geometry.Polygon - Class in uk.ac.starlink.tfcat
  Geometry subclass representing a TFCat Polygon.
getAllGeometries(TfcatObject) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Returns all the Geometries that are descendents of a given TFCat object, including itself if applicable.
getAllPositions(TfcatObject) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Returns all the Position objects contained in a TFCat object and its descendents.
getBbox() - Method in class uk.ac.starlink.tfcat.TfcatObject
  Returns this object's bounding box, if any.
getBboxInScope(TfcatObject) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Returns a Bounding Box objecct applying to the given TFCat object.
getChildren(TfcatObject) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Returns any direct children of a TfcatObject that are themselves TfcatObjects.
getCode() - Method in class uk.ac.starlink.tfcat.TfcatStatus
  Returns a code summarising the validity status.
getCrs() - Method in class uk.ac.starlink.tfcat.TfcatObject
  Returns this object's coordinate reference system, if any.
getCrsInScope(TfcatObject) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Returns a CRS object applying to the given TFCat object.
getCrsType() - Method in interface uk.ac.starlink.tfcat.Crs
  Returns the type member of this CRS object.
getDatatype() - Method in interface uk.ac.starlink.tfcat.Field
  Returns field datatype.
getDistinctPositions() - Method in class uk.ac.starlink.tfcat.LinearRing
  Returns an array of the positions defining this ring; the last one is not a duplicate of the first.
getFeatures() - Method in class uk.ac.starlink.tfcat.FeatureCollection
  Returns the features in this collection.
getFields() - Method in class uk.ac.starlink.tfcat.FeatureCollection
  Returns a map of field names to fields for this collection.
getGeometry() - Method in class uk.ac.starlink.tfcat.Feature
  Returns this feature's geometry.
getId() - Method in class uk.ac.starlink.tfcat.Feature
  Returns this feature's identifier.
getInfo() - Method in interface uk.ac.starlink.tfcat.Field
  Returns field description.
getJson() - Method in class uk.ac.starlink.tfcat.TfcatObject
  Returns the JSON object on which this is based.
getMessage() - Method in class uk.ac.starlink.tfcat.TfcatStatus
  Returns a message containing information about compliancy issues during parsing.
getMessages() - Method in class uk.ac.starlink.tfcat.BasicReporter
  Returns a list of all the messages accumulated by this reporter and its sub-reporters.
getName() - Method in class uk.ac.starlink.tfcat.Datatype
  Returns the name of this datatype, as used in the datatype member of a field.
getName() - Method in interface uk.ac.starlink.tfcat.Field
  Returns the field name.
getName() - Method in class uk.ac.starlink.tfcat.TimeCoords
  Returns this system's name.
getParent() - Method in class uk.ac.starlink.tfcat.TfcatObject
  Returns the parent of this TfcatObject.
getProperties() - Method in class uk.ac.starlink.tfcat.Feature
  Returns this featurs's properties object.
getRefPositionId() - Method in interface uk.ac.starlink.tfcat.LocalCrs
  Returns the reference position ID for this CRS.
getScale() - Method in interface uk.ac.starlink.tfcat.SpectralCoords
  Returns a token giving the scale type for the spectral coordinate system.
getShape() - Method in class uk.ac.starlink.tfcat.Geometry
  Returns the coordinate information giving the content of this geometry.
getSpectral() - Method in class uk.ac.starlink.tfcat.Position
  Returns the spectral coordinate.
getSpectralCoords() - Method in interface uk.ac.starlink.tfcat.LocalCrs
  Returns the spectral coordinate system description for this CRS.
getSpectralMax() - Method in class uk.ac.starlink.tfcat.Bbox
  Returns the maximum spectral value.
getSpectralMin() - Method in class uk.ac.starlink.tfcat.Bbox
  Returns the minimum spectral value.
getStatus(String) - Static method in class uk.ac.starlink.tfcat.TfcatStatus
  Parses a given TFCat text and returns a status.
getTime() - Method in class uk.ac.starlink.tfcat.Position
  Returns the time coordinate.
getTimeCoords() - Method in interface uk.ac.starlink.tfcat.LocalCrs
  Returns the time coordinate system description for this CRS.
getTimeCoordsId() - Method in interface uk.ac.starlink.tfcat.LocalCrs
  Returns the standard time coordinate system identifier for this CRS.
getTimeMax() - Method in class uk.ac.starlink.tfcat.Bbox
  Returns the maximum time value.
getTimeMin() - Method in class uk.ac.starlink.tfcat.Bbox
  Returns the minimum time value.
getTimeOrigin() - Method in class uk.ac.starlink.tfcat.TimeCoords
  Returns this system's time origin.
getTimeScale() - Method in class uk.ac.starlink.tfcat.TimeCoords
  Returns the identifier for this system's time scale.
getType() - Method in interface uk.ac.starlink.tfcat.SpectralCoords
  Returns the spectral coordinate system type.
getType() - Method in class uk.ac.starlink.tfcat.TfcatObject
  Returns the value of the type member, defining the TFCat type.
getTypeClass() - Method in class uk.ac.starlink.tfcat.Datatype
  Returns the object class represented by this datatype.
getUcd() - Method in interface uk.ac.starlink.tfcat.Field
  Returns field Uniform Content Descriptor.
getUcdChecker() - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Returns a syntax checker for UCDs.
getUnit() - Method in interface uk.ac.starlink.tfcat.Field
  Returns field unit.
getUnit() - Method in interface uk.ac.starlink.tfcat.SpectralCoords
  Returns the unit string for this coordinate system.
getUnit() - Method in class uk.ac.starlink.tfcat.TimeCoords
  Returns this system's units.
getUnitChecker() - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Returns a syntax checker for VOUnits.

## H

hashCode() - Method in class uk.ac.starlink.tfcat.Position

## I

INSTANCE - Static variable in class uk.ac.starlink.tfcat.DummyReporter
  Instance suitable for general use.
INT - Static variable in class uk.ac.starlink.tfcat.Datatype
  Integer type.
INVALID - Enum constant in enum class uk.ac.starlink.tfcat.TfcatStatus.Code
  Validity errors were encountered during parse.
isClockwise() - Method in class uk.ac.starlink.tfcat.LinearRing
  Indicates the winding direction for this ring.
isInside(Position) - Method in class uk.ac.starlink.tfcat.Bbox
  Indicates whether a given position is within this bounding box.
isType(String) - Method in class uk.ac.starlink.tfcat.Datatype
  Indicates whether a string value appears to have this type.

## J

JD - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Predefined TimeCoords instance for Julian Day.

## L

LINE_STRING - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for array of Position objects representing TFCat LineString.
LINE_STRINGS - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for an array of LineStrings.
LINEAR_RING - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a LinearRing.
LINEAR_RINGS - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for array of LinearRings.
LinearRing - Class in uk.ac.starlink.tfcat
  Represents a linear ring as defined in the TFCat specification (from the GeoJSON specification).
LinearRing(Position[]) - Constructor for class uk.ac.starlink.tfcat.LinearRing
  Constructor.
LocalCrs - Interface in uk.ac.starlink.tfcat
  Represents a TFCat Local CRS (Coordinate Reference System) structure.

## M

main(String[]) - Static method in class uk.ac.starlink.tfcat.Validate
MJD - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Predefined TimeCoords instance for Modified Julian Day.
MJD_CNES - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Predefined TimeCoords instance for CNES Modified Julian Day.
MJD_NASA - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Predefined TimeCoords instance for NASA Modified Julian Day.

## O

OK - Enum constant in enum class uk.ac.starlink.tfcat.TfcatStatus.Code
  Parse successful, no errors.

## P

parseTfcat(String, Reporter) - Static method in class uk.ac.starlink.tfcat.TfcatUtil
  Performs a validating parse of a given TFCat text.
POLYGON - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for array of LinearRings representing a TFCat Polygon.
POLYGONS - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for an array of TFCat polygons.
Position - Class in uk.ac.starlink.tfcat
  Represents a position in (time, spectral) space.
Position(double, double) - Constructor for class uk.ac.starlink.tfcat.Position
  Constructor.
POSITION - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for Position object.
POSITIONS - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for array of Position objects.
PREDEF_MAP - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Map of predefined time_coords_id strings to TimeCoord instances.
purgeJson() - Method in class uk.ac.starlink.tfcat.Feature
purgeJson() - Method in class uk.ac.starlink.tfcat.Geometry
purgeJson() - Method in class uk.ac.starlink.tfcat.TfcatObject
  Removes any reference to the original parsed JSON from this object.

## R

report(String) - Method in class uk.ac.starlink.tfcat.BasicReporter
report(String) - Method in class uk.ac.starlink.tfcat.DummyReporter
report(String) - Method in interface uk.ac.starlink.tfcat.Reporter
  Reports an error message.
Reporter - Interface in uk.ac.starlink.tfcat
  Recipient for validation messages.

## S

SCALE_VALUES - Static variable in interface uk.ac.starlink.tfcat.SpectralCoords
  Permitted values for SpectralCoords scale attribute.
SPECTRAL_COORDS - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a SpectralCoords object.
SpectralCoords - Interface in uk.ac.starlink.tfcat
  Represents a TFCat SpectralCoords object.
STRING - Static variable in class uk.ac.starlink.tfcat.Datatype
  String type.

## T

TFCAT - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a TFCat object.
TfcatObject - Class in uk.ac.starlink.tfcat
  Superclass for TFCat objects.
TfcatObject(JSONObject, String, Crs, Bbox) - Constructor for class uk.ac.starlink.tfcat.TfcatObject
  Constructor.
TfcatStatus - Class in uk.ac.starlink.tfcat
  Utility class to represent the validity status of a TFCat text.
TfcatStatus(TfcatStatus.Code, String) - Constructor for class uk.ac.starlink.tfcat.TfcatStatus
  Constructor.
TfcatStatus.Code - Enum Class in uk.ac.starlink.tfcat
  Parse result code.
TfcatUtil - Class in uk.ac.starlink.tfcat
  Utilities for use with TFCat classes.
TIME_COORDS - Static variable in class uk.ac.starlink.tfcat.Decoders
  Decoder for a TimeCoords object.
TIME_ORIGIN_REGEX - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Regex for legal TFCat/DALI ISO-8601 time representations.
TIME_SCALES - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Collection of permitted time scale values.
TimeCoords - Class in uk.ac.starlink.tfcat
  Represents a TFCat TimeCoords object.
TimeCoords() - Constructor for class uk.ac.starlink.tfcat.TimeCoords
toString() - Method in class uk.ac.starlink.tfcat.Bbox
toString() - Method in class uk.ac.starlink.tfcat.Datatype
toString() - Method in class uk.ac.starlink.tfcat.Position
TYPE_VALUES - Static variable in interface uk.ac.starlink.tfcat.SpectralCoords
  Permitted values for SpectralCoords type attribute.

## U

uk.ac.starlink.tfcat - package uk.ac.starlink.tfcat
  This package contains a parser and validator for the Time-Frequency Radio Catalogues standard, defined at see https://doi.org/10.25935/6068-8528.
UNIX - Static variable in class uk.ac.starlink.tfcat.TimeCoords
  Predefined TimeCoords instance for Unix timestamp.

## V

Validate - Class in uk.ac.starlink.tfcat
  Provides a main method which validates TFCat texts.
Validate() - Constructor for class uk.ac.starlink.tfcat.Validate
valueOf(String) - Static method in enum class uk.ac.starlink.tfcat.TfcatStatus.Code
  Returns the enum constant of this class with the specified name.
values() - Static method in enum class uk.ac.starlink.tfcat.TfcatStatus.Code
  Returns an array containing the constants of this enum class, in the order they are declared.

## W

WordChecker - Interface in uk.ac.starlink.tfcat
  Interface for simple syntax checking.

A B C D E F G H I J L M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values