com.imsweb.staging

Class Staging

java.lang.Object

com.imsweb.staging.Staging

public final class Staging
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	CONTEXT_KEYS
static java.lang.String	CTX_ALGORITHM_VERSION
static java.lang.String	CTX_YEAR_CURRENT

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	findMatchingTableRow(java.lang.String tableId, java.util.Map<java.lang.String,java.lang.String> context) For a given table, return the index of the row that matches supplied context.
java.lang.Integer	findMatchingTableRow(java.lang.String tableId, java.lang.String key, java.lang.String value) For a given table, return the index of the row that matches the key/value combination.
java.lang.String	getAlgorithm() Return the algorithm name
java.util.Set<java.lang.String>	getInputs(StagingMapping mapping) Looks at all tables involved in the mapping and returns a list of input keys that could be used.
java.util.Set<java.lang.String>	getInputs(StagingMapping mapping, java.util.Map<java.lang.String,java.lang.String> context, java.util.Set<java.lang.String> excludedInputs) Looks at all tables involved in the mapping and returns a list of input keys that could be used.
java.util.Set<java.lang.String>	getInputs(StagingSchema schema) Looks at all tables involved in all the mappings in the definition and returns a list of input keys that could be used.
java.util.Set<java.lang.String>	getInputs(StagingSchema schema, java.util.Map<java.lang.String,java.lang.String> context) Looks at all tables involved in all the mappings in the definition and returns a list of input keys that could be used.
java.util.Set<java.lang.String>	getInputs(StagingTablePath path) Looks at all tables involved in the table path and returns a list of input keys that could be used.
java.util.Set<java.lang.String>	getInputs(StagingTablePath path, java.util.Set<java.lang.String> excludedInputs) Looks at all tables involved in the table path and returns a list of input keys that could be used.
static Staging	getInstance(StagingDataProvider provider) Create an instance of the Staging object with a pre-constructed provider
java.util.Set<java.lang.String>	getInvolvedSchemas(java.lang.String tableId) Return a list of schema identifiers which the specified table is used in
java.util.Set<java.lang.String>	getInvolvedTables(java.lang.String schemaId) Return a list of tables identifiers involved in the specified schema
java.util.Set<java.lang.String>	getOutputs(StagingMapping mapping) Looks at all tables involved in the mapping and returns a list of output keys that could be created.
java.util.Set<java.lang.String>	getOutputs(StagingMapping mapping, java.util.Map<java.lang.String,java.lang.String> context) Looks at all tables involved in the mapping and returns a list of output keys that could be created.
java.util.Set<java.lang.String>	getOutputs(StagingSchema schema) Looks at all tables involved in all the mappings in the definition and returns a list of output keys that could be created.
java.util.Set<java.lang.String>	getOutputs(StagingSchema schema, java.util.Map<java.lang.String,java.lang.String> context) Looks at all tables involved in all the mappings in the definition and returns a list of output keys that will be created.
java.util.Set<java.lang.String>	getOutputs(StagingTablePath path) Looks at a table path (and all jump tables within in) and returns a list of output keys that could be created.
StagingSchema	getSchema(java.lang.String id) Return a schema based on schema id
java.util.Set<java.lang.String>	getSchemaIds() Return the list a schema ids
StagingTable	getTable(java.lang.String id) Return a mapping table based on table name
java.util.Set<java.lang.String>	getTableIds() Return a complete list of mapping table names
java.lang.String	getVersion() Return the data version
boolean	isCodeValid(java.lang.String schemaId, java.lang.String key, java.lang.String value) Check the code validity of a single field in a schema.
boolean	isContextValid(java.lang.String schemaId, java.lang.String key, java.util.Map<java.lang.String,java.lang.String> context) Check the validity of a single field of a schema based on the supplied context.
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.
StagingData	stage(StagingData data) Stage the passed case.

Methods inherited from class java.lang.Object

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

Field Detail

CTX_ALGORITHM_VERSION

public static final java.lang.String CTX_ALGORITHM_VERSION

See Also:

Constant Field Values

CTX_YEAR_CURRENT

public static final java.lang.String CTX_YEAR_CURRENT

See Also:

Constant Field Values

CONTEXT_KEYS

public static final java.util.List<java.lang.String> CONTEXT_KEYS

Method Detail

getInstance

public static Staging getInstance(StagingDataProvider provider)

Create an instance of the Staging object with a pre-constructed provider

Parameters:

provider - StagingDataProvider

Returns:

a Staging instance

getAlgorithm

public java.lang.String getAlgorithm()

Return the algorithm name

Returns:

an Algorithm

getVersion

public java.lang.String getVersion()

Return the data version

Returns:

a version string

getSchemaIds

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

Return the list a schema ids

Returns:

a Set of Strings of schema ids

getSchema

public StagingSchema getSchema(java.lang.String id)

Return a schema based on schema id

Parameters:

id - Schema identifier

Returns:

an Algorithm object

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

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 StagingSchema objects

getTableIds

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

Return a complete list of mapping table names

Returns:

Set of String objects containing table names

getTable

public StagingTable getTable(java.lang.String id)

Return a mapping table based on table name

Parameters:

id - table identifier

Returns:

Table object

isCodeValid

public boolean isCodeValid(java.lang.String schemaId,
                           java.lang.String key,
                           java.lang.String value)

Check the code validity of a single field in a schema. If the schema or field do no exist, false will be returned.

Parameters:

schemaId - schema identifier

key - input key

value - value to check validity

Returns:

a boolean indicating whether the code exists for the the passed schema field

isContextValid

public boolean isContextValid(java.lang.String schemaId,
                              java.lang.String key,
                              java.util.Map<java.lang.String,java.lang.String> context)

Check the validity of a single field of a schema based on the supplied context. The value of this key should be in the context as well as any other properties needed to evaluation validity. If the schema or field do no exist, false will be returned.

Parameters:

schemaId - schema identifier

key - input key

context - Map of keys/values to validate against

Returns:

a boolean indicating whether the code exists for the the passed schema field

findMatchingTableRow

public java.lang.Integer findMatchingTableRow(java.lang.String tableId,
                                              java.lang.String key,
                                              java.lang.String value)

For a given table, return the index of the row that matches the key/value combination. If you need to match on more than one input, see the other findMatchingTableRow.

Parameters:

tableId - table identifier

key - input key

value - value

Returns:

the index of the matching table row or null if no match was found

findMatchingTableRow

public java.lang.Integer findMatchingTableRow(java.lang.String tableId,
                                              java.util.Map<java.lang.String,java.lang.String> context)

For a given table, return the index of the row that matches supplied context.

Parameters:

tableId - table identifier

context - context of input key/values to use to match

Returns:

the index of the matching table row or null if no match was found

getInvolvedTables

public java.util.Set<java.lang.String> getInvolvedTables(java.lang.String schemaId)

Return a list of tables identifiers involved in the specified schema

Parameters:

schemaId - schema identifier

Returns:

a Set of table identifiers; if the schema is not found the set will be empty

getInvolvedSchemas

public java.util.Set<java.lang.String> getInvolvedSchemas(java.lang.String tableId)

Return a list of schema identifiers which the specified table is used in

Parameters:

tableId - table identifier

Returns:

a Set of schema identifiers

getInputs

public java.util.Set<java.lang.String> getInputs(StagingTablePath path)

Looks at all tables involved in the table path and returns a list of input keys that could be used. This also includes the input keys used in jumps tables.

Parameters:

path - a StagingTablePath

Returns:

a Set of unique input keys

getInputs

public java.util.Set<java.lang.String> getInputs(StagingTablePath path,
                                                 java.util.Set<java.lang.String> excludedInputs)

Looks at all tables involved in the table path and returns a list of input keys that could be used. This also includes the input keys used in jumps tables.

Parameters:

path - a StagingTablePath

excludedInputs - a list of input keys to not consider as inputs

Returns:

a Set of unique input keys

getInputs

public java.util.Set<java.lang.String> getInputs(StagingMapping mapping)

Looks at all tables involved in the mapping and returns a list of input keys that could be used. This also includes the input keys used in the inclusion and exclusion tables if any.

Parameters:

mapping - a StagingMapping

Returns:

a Set of unique input keys

getInputs

public java.util.Set<java.lang.String> getInputs(StagingMapping mapping,
                                                 java.util.Map<java.lang.String,java.lang.String> context,
                                                 java.util.Set<java.lang.String> excludedInputs)

Looks at all tables involved in the mapping and returns a list of input keys that could be used. This always includes the input keys used in the inclusion and exclusion tables if any. The inputs from each table path will only be included if it passes the inclusion/exclusion criteria based on the context.

Parameters:

mapping - a StagingMapping

context - a context of values used to to check mapping inclusion/exclusion

excludedInputs - a list of input keys to not consider as inputs

Returns:

a Set of unique input keys

getInputs

public java.util.Set<java.lang.String> getInputs(StagingSchema schema)

Looks at all tables involved in all the mappings in the definition and returns a list of input keys that could be used. It will also deal with mapped inputs. Note that if an input to a table was not a supplied input (i.e. it was created as an output of a previous table) it will not be included in the list of inputs. The inputs will also include any used in schema selection. All inputs returned from this method should be in the schema input list otherwise there is a problem with the schema.

Parameters:

schema - a StagingSchema

Returns:

a Set of unique input keys

getInputs

public java.util.Set<java.lang.String> getInputs(StagingSchema schema,
                                                 java.util.Map<java.lang.String,java.lang.String> context)

Looks at all tables involved in all the mappings in the definition and returns a list of input keys that could be used. It will also deal with mapped inputs. The inputs from each mapping will only be included if it passes the inclusion/exclusion criteria based on the context. Note that if an input to a table was not a supplied input (i.e. it was created as an output of a previous table) it will not be included in the list of inputs. The inputs will also include any used in schema selection. All inputs returned from this method should be in the schema input list otherwise there is a problem with the schema.

Parameters:

schema - a StagingSchema

context - a context of values used to to check mapping inclusion/exclusion

Returns:

a Set of unique input keys

getOutputs

public java.util.Set<java.lang.String> getOutputs(StagingTablePath path)

Looks at a table path (and all jump tables within in) and returns a list of output keys that could be created.

Parameters:

path - a StagingTablePath

Returns:

a Set of unique output keys

getOutputs

public java.util.Set<java.lang.String> getOutputs(StagingMapping mapping)

Looks at all tables involved in the mapping and returns a list of output keys that could be created. This also includes the output keys used in the inclusion and exclusion tables if any.

Parameters:

mapping - a StagingMapping

Returns:

a Set of unique output keys

getOutputs

public java.util.Set<java.lang.String> getOutputs(StagingMapping mapping,
                                                  java.util.Map<java.lang.String,java.lang.String> context)

Looks at all tables involved in the mapping and returns a list of output keys that could be created. This also includes the output keys used in the inclusion and exclusion tables if any. The outputs from each mapping will only be included if it passes the inclusion/exclusion criteria based on the context.

Parameters:

mapping - a StagingMapping

context - a context of values used to to check mapping inclusion/exclusion

Returns:

a Set of unique output keys

getOutputs

public java.util.Set<java.lang.String> getOutputs(StagingSchema schema)

Looks at all tables involved in all the mappings in the definition and returns a list of output keys that could be created. It will also deal with mapped outputs.

Parameters:

schema - a StagingSchema

Returns:

a Set of unique output keys

getOutputs

public java.util.Set<java.lang.String> getOutputs(StagingSchema schema,
                                                  java.util.Map<java.lang.String,java.lang.String> context)

Looks at all tables involved in all the mappings in the definition and returns a list of output keys that will be created. It will also deal with mapped outputs. The outputs from each mapping will only be included if it passes the inclusion/exclusion criteria based on the context. If the schema has StagingOutputs defined, then the calulated output list is exactly the same as the schema output list.

Parameters:

schema - a StagingSchema

context - a context of values used to to check mapping inclusion/exclusion

Returns:

a Set of unique output keys

stage

public StagingData stage(StagingData data)

Stage the passed case.

Parameters:

data - all input values are passed through this database

Returns:

the same StagingData with output values filled in