uk.ac.starlink.ttools.plot2.data

Class SimpleDomain<T>

java.lang.Object

uk.ac.starlink.ttools.plot2.data.SimpleDomain<T>

All Implemented Interfaces:

Domain<SimpleDomain.Mapper<T>>

public class SimpleDomain<T>
extends Object
implements Domain<SimpleDomain.Mapper<T>>

Minimal Domain implementation with only one mapper.

Since:

14 Apr 2020

Author:

Mark Taylor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleDomain.Mapper<T> Simple mapper implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleDomain<Number>	NUMERIC_DOMAIN SimpleDomain instance for numeric values.
static SimpleDomain.Mapper<Number>	NUMERIC_MAPPER Sole DomainMapper for NUMERIC_DOMAIN.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleDomain(Class<T> clazz, String domainName, String sourceName, String sourceDescription) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getDomainName() Returns the name of this domain.
SimpleDomain.Mapper<T>	getMapper() Returns sole default mapper instance for this domain.
SimpleDomain.Mapper<T>[]	getMappers() Returns a list of all mappers known to map values to this domain.
SimpleDomain.Mapper<T>	getPossibleMapper(ValueInfo info) Returns a typed DomainMapper that can be used for data described by the given metadata object.
SimpleDomain.Mapper<T>	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

NUMERIC_DOMAIN

public static final SimpleDomain<Number> NUMERIC_DOMAIN

SimpleDomain instance for numeric values.

NUMERIC_MAPPER

public static final SimpleDomain.Mapper<Number> NUMERIC_MAPPER

Sole DomainMapper for NUMERIC_DOMAIN.

Constructor Detail

SimpleDomain

protected SimpleDomain(Class<T> clazz,
                       String domainName,
                       String sourceName,
                       String sourceDescription)

Constructor.

Parameters:

clazz - required source class

domainName - target domain name

sourceName - source value name

sourceDescription - source value description

Method Detail

getDomainName

public String getDomainName()

Description copied from interface: Domain

Returns the name of this domain.

Specified by:

getDomainName in interface Domain<SimpleDomain.Mapper<T>>

Returns:

domain name

getMappers

public SimpleDomain.Mapper<T>[] 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<SimpleDomain.Mapper<T>>

Returns:

list of generic mappers to this domain

getProbableMapper

public SimpleDomain.Mapper<T> 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<SimpleDomain.Mapper<T>>

Parameters:

info - metadata describing data to be mapped

Returns:

reliable guess at a suitable mapper

getPossibleMapper

public SimpleDomain.Mapper<T> 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<SimpleDomain.Mapper<T>>

Parameters:

info - metadata describing data to be mapped

Returns:

best-efforts guess at a suitable mapper

getMapper

public SimpleDomain.Mapper<T> getMapper()

Returns sole default mapper instance for this domain.

Returns:

mapper