uk.ac.starlink.ttools.plot2.data

Class FixedLengthVectorCoord.VectorDomain

java.lang.Object

uk.ac.starlink.ttools.plot2.data.FixedLengthVectorCoord.VectorDomain

All Implemented Interfaces:

Domain<FixedLengthVectorCoord.VectorDomain>, DomainMapper

Enclosing class:

FixedLengthVectorCoord

public static class FixedLengthVectorCoord.VectorDomain
extends Object
implements Domain<FixedLengthVectorCoord.VectorDomain>, DomainMapper

Domain for use with FixedLengthVectorCoord. Note it is its own sole mapper, so it implements both the Domain and DomainMapper interfaces.

Constructor Summary

Constructors

Constructor and Description
VectorDomain(int nel, Class<?>[] userClasses) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDomainName() Returns the name of this domain.
FixedLengthVectorCoord.VectorDomain[]	getMappers() Returns a list of all mappers known to map values to this domain.
FixedLengthVectorCoord.VectorDomain	getPossibleMapper(ValueInfo info) Returns a typed DomainMapper that can be used for data described by the given metadata object.
FixedLengthVectorCoord.VectorDomain	getProbableMapper(ValueInfo info) Returns a typed DomainMapper that is likely to be appropriate for data described by the given metadata object.
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.
FixedLengthVectorCoord.VectorDomain	getTargetDomain() Returns the target domain of this mapper.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorDomain

public VectorDomain(int nel,
                    Class<?>[] userClasses)

Constructor.

Parameters:

nel - fixed number of elements in array

userClasses - classes of user object that can be handled int this domain

Method Detail

getDomainName

public String getDomainName()

Description copied from interface: Domain

Returns the name of this domain.

Specified by:

getDomainName in interface Domain<FixedLengthVectorCoord.VectorDomain>

Returns:

domain name

getMappers

public FixedLengthVectorCoord.VectorDomain[] 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<FixedLengthVectorCoord.VectorDomain>

Returns:

list of generic mappers to this domain

getProbableMapper

public FixedLengthVectorCoord.VectorDomain 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<FixedLengthVectorCoord.VectorDomain>

Parameters:

info - metadata describing data to be mapped

Returns:

reliable guess at a suitable mapper

getPossibleMapper

public FixedLengthVectorCoord.VectorDomain 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<FixedLengthVectorCoord.VectorDomain>

Parameters:

info - metadata describing data to be mapped

Returns:

best-efforts guess at a suitable mapper

getTargetDomain

public FixedLengthVectorCoord.VectorDomain 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:

domain identifier

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object