uk.ac.starlink.ttools

Class AreaMapper

java.lang.Object

uk.ac.starlink.ttools.AreaMapper

All Implemented Interfaces:

DomainMapper

public abstract class AreaMapper
extends Object
implements DomainMapper

DomainMapper for AreaDomain.

Since:

14 Apr 2020

Author:

Mark Taylor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AreaMapper(String sourceName, String sourceDescription, Class<?> sourceClazz) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract java.util.function.Function<Object,Area>	areaFunction(Class<?> aclazz) Returns a function that can map source objects of a given class to corresponding Area instances.
String	getSkySourceDescription() Returns a version of the source description text that is suitable for use in the context of sky coordinates.
Class<?>	getSourceClass() Returns the type of values from which this mapper instance can convert.
String	getSourceDescription() Returns a description of the type of source values which this mapper can convert from.
String	getSourceName() Returns a short name for the type of source values which this mapper can convert from.
AreaDomain	getTargetDomain() Returns the target domain of this mapper.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaMapper

protected AreaMapper(String sourceName,
                     String sourceDescription,
                     Class<?> sourceClazz)

Constructor.

Parameters:

sourceName - source name

sourceDescription - source description, may include XML formatting but don't wrap in <p> tags

sourceClazz - source class

Method Detail

getTargetDomain

public AreaDomain getTargetDomain()

Description copied from interface: DomainMapper

Returns the target domain of this mapper. An abstract DomainMapper sub-type should normally implement this as a final method with a fixed return value.

Specified by:

getTargetDomain in interface DomainMapper

Returns:

AreaDomain.INSTANCE

getSourceClass

public Class<?> getSourceClass()

Description copied from interface: DomainMapper

Returns the type of values from which this mapper instance can convert. This should be as specific as possible to cover all the possible options, but in some cases that may mean it has simply to return Object.class.

Specified by:

getSourceClass in interface DomainMapper

Returns:

class of mappable source objects to which this mapper can be applied

getSourceName

public String getSourceName()

Description copied from interface: DomainMapper

Returns a short name for the type of source values which this mapper can convert from.

Specified by:

getSourceName in interface DomainMapper

Returns:

mapper source type name

getSourceDescription

public String getSourceDescription()

Description copied from interface: DomainMapper

Returns a description of the type of source values which this mapper can convert from.

Specified by:

getSourceDescription in interface DomainMapper

Returns:

mapper source type description

getSkySourceDescription

public String getSkySourceDescription()

Returns a version of the source description text that is suitable for use in the context of sky coordinates.

The default implementation simply calls getSourceDescription().

Returns:

sky description

areaFunction

public abstract java.util.function.Function<Object,Area> areaFunction(Class<?> aclazz)

Returns a function that can map source objects of a given class to corresponding Area instances.

Parameters:

aclazz - class of objects that is to be mapped

Returns:

function that converts typed objects to Area instances

toString

public String toString()

Overrides:

toString in class Object