com.imsweb.staging

Class StagingDataProvider

java.lang.Object

com.imsweb.staging.StagingDataProvider

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

ExternalStagingFileDataProvider, StagingFileDataProvider

public abstract class StagingDataProvider
extends java.lang.Object
implements DataProvider

An abstract implementation of DataProvider customized for handling staging schemas/tables

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HISTOLOGY_TABLE
static java.lang.String	PRIMARY_SITE_TABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StagingDataProvider() Constructor loads all schemas and sets up cache

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getAlgorithm() Return the algorithm associated with the provider
abstract StagingSchema	getDefinition(java.lang.String id) Get an definition by identifier
com.fasterxml.jackson.databind.ObjectMapper	getMapper() Return the ObjectMapper instance
abstract java.util.Set<java.lang.String>	getSchemaIds() Return a set of all schema identifiers
abstract StagingTable	getTable(java.lang.String id) Get a table by identifier
abstract java.util.Set<java.lang.String>	getTableIds() Return a set of all the table names
java.util.Set<java.lang.String>	getValidHistologies() Return all the legal histology values
java.util.Set<java.lang.String>	getValidSites() Return all the legal site values
abstract java.lang.String	getVersion() Return the version associated with the provider
static StagingSchema	initSchema(StagingSchema schema) Initialize a schema.
static StagingTable	initTable(StagingTable table) Initialize a table.
void	invalidateCache() Clear the caches
boolean	isValidHistology(java.lang.String histology) Return true if the histology is valid
boolean	isValidSite(java.lang.String site) Return true if the site is valid
java.util.List<StagingSchema>	lookupSchema(SchemaLookup lookup) Look up a schema based on site, histology and an optional discriminator.
static StagingEndpoint	parseEndpoint(java.lang.String endpoint) Parse the string representation of an endpoint into a Endpoint object
static java.util.List<StagingRange>	splitValues(java.lang.String values) Parses a string in having lists of ranges into a List of Range objects

Methods inherited from class java.lang.Object

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

Field Detail

PRIMARY_SITE_TABLE

public static final java.lang.String PRIMARY_SITE_TABLE

See Also:

Constant Field Values

HISTOLOGY_TABLE

public static final java.lang.String HISTOLOGY_TABLE

See Also:

Constant Field Values

Constructor Detail

StagingDataProvider

protected StagingDataProvider()

Constructor loads all schemas and sets up cache

Method Detail

initSchema

public static StagingSchema initSchema(StagingSchema schema)

Initialize a schema.

Parameters:

schema - schema entity

Returns:

initialized schema entity

initTable

public static StagingTable initTable(StagingTable table)

Initialize a table.

Parameters:

table - table entity

Returns:

initialized table entity

parseEndpoint

public static StagingEndpoint parseEndpoint(java.lang.String endpoint)

Parse the string representation of an endpoint into a Endpoint object

Parameters:

endpoint - endpoint String

Returns:

an Endpoint object

splitValues

public static java.util.List<StagingRange> splitValues(java.lang.String values)

Parses a string in having lists of ranges into a List of Range objects

Parameters:

values - String representing sets value ranges

Returns:

a parsed list of string Range objects

invalidateCache

public void invalidateCache()

Clear the caches

isValidSite

public boolean isValidSite(java.lang.String site)

Return true if the site is valid

Parameters:

site - primary site

Returns:

true if the side is valid

isValidHistology

public boolean isValidHistology(java.lang.String histology)

Return true if the histology is valid

Parameters:

histology - histology

Returns:

true if the histology is valid

getMapper

public com.fasterxml.jackson.databind.ObjectMapper getMapper()

Return the ObjectMapper instance

Returns:

ObjectMapper instance

getAlgorithm

public abstract java.lang.String getAlgorithm()

Return the algorithm associated with the provider

Returns:

algorithm id

getVersion

public abstract java.lang.String getVersion()

Return the version associated with the provider

Returns:

version number

getTable

public abstract StagingTable getTable(java.lang.String id)

Description copied from interface: DataProvider

Get a table by identifier

Specified by:

getTable in interface DataProvider

Parameters:

id - the table id

Returns:

a Table instance or null if identifier was not found

getDefinition

public abstract StagingSchema getDefinition(java.lang.String id)

Description copied from interface: DataProvider

Get an definition by identifier

Specified by:

getDefinition in interface DataProvider

Parameters:

id - the definition id

Returns:

a Definition instance or null if identifier was not found

getSchemaIds

public abstract java.util.Set<java.lang.String> getSchemaIds()

Return a set of all schema identifiers

Returns:

a Set of schema identifiers

getTableIds

public abstract java.util.Set<java.lang.String> getTableIds()

Return a set of all the table names

Returns:

a List of table identifier

getValidSites

public java.util.Set<java.lang.String> getValidSites()

Return all the legal site values

Returns:

a set of valid sites

getValidHistologies

public java.util.Set<java.lang.String> getValidHistologies()

Return all the legal histology values

Returns:

a set of valid histologies

lookupSchema

public java.util.List<StagingSchema> lookupSchema(SchemaLookup lookup)

Look up a schema based on site, histology and an optional discriminator.

Parameters:

lookup - schema lookup input

Returns:

a list of StagingSchemaInfo objects