uk.ac.starlink.ttools.plot2.data

Class AreaDomain

java.lang.Object

uk.ac.starlink.ttools.plot2.data.AreaDomain

All Implemented Interfaces:

Domain<AreaMapper>

public class AreaDomain
extends Object
implements Domain<AreaMapper>

Domain representing two-dimensional regions on a common surface. The surface may be a plane or the surface of a sphere.

The sole instance of this singleton class is available as the INSTANCE static member.

Since:

14 Apr 2020

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static AreaMapper	ASCIIMOC_MAPPER Mapper for ASCII format MOCs.
static AreaMapper	CIRCLE_MAPPER Mapper for (x,y,r) circles - see DALI 1.1 section 3.3.6.
static AreaDomain	INSTANCE Singleton instance.
static AreaMapper	POINT_MAPPER Mapper for (x,y) points - see DALI 1.1 section 3.3.5.
static AreaMapper	POLYGON_MAPPER Mapper for (xi,yi,...) polygons - see DALI 1.1 section 3.3.7.
static AreaMapper	STCS_MAPPER STC-S - see TAP 1.0 section 6.
static AreaMapper	TFCAT_MAPPER Mapper for TFCat strings.
static AreaMapper	UNIQ_MAPPER Mapper for single HEALPix UNIQ values.

Method Summary

Modifier and Type	Method and Description
String	getDomainName() Returns the name of this domain.
AreaMapper[]	getMappers() Returns a list of all mappers known to map values to this domain.
AreaMapper	getPossibleMapper(ValueInfo info) Returns a typed DomainMapper that can be used for data described by the given metadata object.
AreaMapper	getProbableMapper(ValueInfo info) Returns a typed DomainMapper that is likely to be appropriate for data described by the given metadata object.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final AreaDomain INSTANCE

Singleton instance.

STCS_MAPPER

public static final AreaMapper STCS_MAPPER

STC-S - see TAP 1.0 section 6.

CIRCLE_MAPPER

public static final AreaMapper CIRCLE_MAPPER

Mapper for (x,y,r) circles - see DALI 1.1 section 3.3.6.

POLYGON_MAPPER

public static final AreaMapper POLYGON_MAPPER

Mapper for (xi,yi,...) polygons - see DALI 1.1 section 3.3.7.

POINT_MAPPER

public static final AreaMapper POINT_MAPPER

Mapper for (x,y) points - see DALI 1.1 section 3.3.5.

ASCIIMOC_MAPPER

public static final AreaMapper ASCIIMOC_MAPPER

Mapper for ASCII format MOCs.

UNIQ_MAPPER

public static final AreaMapper UNIQ_MAPPER

Mapper for single HEALPix UNIQ values.

TFCAT_MAPPER

public static final AreaMapper TFCAT_MAPPER

Mapper for TFCat strings.

Method Detail

getDomainName

public String getDomainName()

Description copied from interface: Domain

Returns the name of this domain.

Specified by:

getDomainName in interface Domain<AreaMapper>

Returns:

domain name

getMappers

public AreaMapper[] getMappers()

Description copied from interface: Domain

Returns a list of all mappers known to map values to this domain. This is not necessarily exhaustive, and may in particular not include mappers specific to certain input file formats, but it can be offered to users as a list of options for mapping to this domain where no other option is obvious.

Specified by:

getMappers in interface Domain<AreaMapper>

Returns:

list of generic mappers to this domain

getProbableMapper

public AreaMapper getProbableMapper(ValueInfo info)

Description copied from interface: Domain

Returns a typed DomainMapper that is likely to be appropriate for data described by the given metadata object.

In general, implementations of this method will first check the ValueInfo.getDomainMappers() method. If it is doubtful how to map from the given info to this domain, null should be returned.

Specified by:

getProbableMapper in interface Domain<AreaMapper>

Parameters:

info - metadata describing data to be mapped

Returns:

reliable guess at a suitable mapper

getPossibleMapper

public AreaMapper getPossibleMapper(ValueInfo info)

Description copied from interface: Domain

Returns a typed DomainMapper that can be used for data described by the given metadata object. If some reasonable way to make the conversion exists, an appropriate value should be returned, but it's quite possible the conversion will be incorrect. If there is no known possible or plausible mapper, null should be returned.

If the result of Domain.getProbableMapper(uk.ac.starlink.table.ValueInfo) is non-null, then this method must also return non-null, but this method is not required to return the same value as getProbableMapper.

Specified by:

getPossibleMapper in interface Domain<AreaMapper>

Parameters:

info - metadata describing data to be mapped

Returns:

best-efforts guess at a suitable mapper