jigcell.compare.data.type
Class TimeSeriesTypeChecker

java.lang.Object
  jigcell.compare.data.type.TypeChecker
      jigcell.compare.data.type.ListTypeChecker
          jigcell.compare.data.type.StructuredTypeChecker
              jigcell.compare.data.type.TimeSeriesTypeChecker

All Implemented Interfaces:

IStructuredTypeChecker, ITypeChecker

public class TimeSeriesTypeChecker
extends StructuredTypeChecker

Type for time series data.

This code is licensed under the DARPA BioCOMP Open Source License. See LICENSE for more details.

Author:

Nicholas Allen

Field Summary

protected static java.lang.String	DEFAULT_SERIESNAME Default prefix for series with no names
private java.lang.String[]	seriesNames Series names
protected static java.lang.String	TYPE_NAME Name of this type
protected static ITypeChecker	TYPE_SINGLETON Instance of this type

Fields inherited from class jigcell.compare.data.type.TypeChecker

COMPARATOR_NAME

Fields inherited from interface jigcell.compare.ITypeChecker

ATTRIBUTE_TYPE, METHOD_GENERATE, OPTION_TYPECHECKER

Constructor Summary

protected	TimeSeriesTypeChecker() Creates a new type checker.
	TimeSeriesTypeChecker(java.lang.String typeName) Creates a new type checker.

Method Summary

static ITypeChecker	getInstance() A type checker.
java.lang.String	getName() A name for this type.
java.lang.String	getName(long pos) A name for the element at this position. Implementations that do not want to provide a name should return null.
ITypeChecker	getTypeChecker(long pos) A type checker for the element at this position. Implementations that do not want to provide a type checker should return null.
boolean	isCompatible(ITypeChecker type) Whether a data type can be converted to this type.
boolean	validate(IDataElement data) Whether a data element is an instance of this type.

Methods inherited from class jigcell.compare.data.type.StructuredTypeChecker

getDescription, getPrototype

Methods inherited from class jigcell.compare.data.type.ListTypeChecker

getType

Methods inherited from class jigcell.compare.data.type.TypeChecker

compareByName, getDescription, getTypeCheckerForGenerator, isCompatible, toString, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface jigcell.compare.ITypeChecker

getDescription, getType

Field Detail

DEFAULT_SERIESNAME

protected static final java.lang.String DEFAULT_SERIESNAME

Default prefix for series with no names

See Also:

Constant Field Values

TYPE_NAME

protected static final java.lang.String TYPE_NAME

Name of this type

See Also:

Constant Field Values

TYPE_SINGLETON

protected static final ITypeChecker TYPE_SINGLETON

Instance of this type

seriesNames

private java.lang.String[] seriesNames

Series names

Constructor Detail

TimeSeriesTypeChecker

public TimeSeriesTypeChecker(java.lang.String typeName)

Creates a new type checker.

Parameters:

typeName - An encoded name for the time series described by this type checker. The encoded name has the form "time-X-Y series" where there can be any number of series names specified.

TimeSeriesTypeChecker

protected TimeSeriesTypeChecker()

Creates a new type checker.

Method Detail

getInstance

public static ITypeChecker getInstance()

A type checker.

getName

public java.lang.String getName()

A name for this type.

Specified by:

getName in interface ITypeChecker

Overrides:

getName in class ListTypeChecker

getName

public java.lang.String getName(long pos)

A name for the element at this position. Implementations that do not want to provide a name should return null.

Specified by:

getName in interface IStructuredTypeChecker

Overrides:

getName in class StructuredTypeChecker

getTypeChecker

public ITypeChecker getTypeChecker(long pos)

A type checker for the element at this position. Implementations that do not want to provide a type checker should return null.

Specified by:

getTypeChecker in interface IStructuredTypeChecker

Overrides:

getTypeChecker in class StructuredTypeChecker

isCompatible

public boolean isCompatible(ITypeChecker type)

Whether a data type can be converted to this type.

Specified by:

isCompatible in interface ITypeChecker

Overrides:

isCompatible in class TypeChecker

Parameters:

type - Type to convert from

validate

public boolean validate(IDataElement data)

Whether a data element is an instance of this type.

Specified by:

validate in interface ITypeChecker

Overrides:

validate in class TypeChecker

Parameters:

data - Data element