ProductionCurationService (Macaw classes)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

macaw.persistenceLayer.production
Class ProductionCurationService

java.lang.Object
  macaw.persistenceLayer.production.ProductionCurationService

All Implemented Interfaces:: MacawCurationAPI

public class ProductionCurationService
extends java.lang.Object
implements MacawCurationAPI
extends java.lang.Object
implements MacawCurationAPI

Implements the interface MacawCurationAPI as a curation service which stores data in a MySQL database. The structure of ProductionCurationService is very similar to that of DemonstrationCurationService. Both classes delegate handling API calls to manager classes that are each designed to support a major concept from the package macaw.model (eg: SupportingDocument, Variable, User)

Copyright 2010 Medical Research Council Unit for Lifelong Health and Ageing Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Version:: 1.0
Author:: Kevin Garwood (kgarwood@users.sourceforge.net)

Constructor Summary
`ProductionCurationService(SessionProperties sessionProperties)`

Method Summary
`void`	`addAliasFilePath(User user, AliasFilePath aliasFilePath)`
`void`	`addAvailabilityState(User user, AvailabilityState availabilityState)`
`void`	`addCategory(User user, Category category)`
`void`	`addCleaningState(User user, CleaningState cleaningState)`
`void`	`addDerivedVariable(User user, DerivedVariable derivedVariable)`
`void`	`addOntologyTerm(User user, OntologyTerm ontologyTerm)`
`void`	`addRawVariable(User user, RawVariable rawVariable)`
`void`	`addSupportingDocument(User user, SupportingDocument supportingDocument)`
`void`	`addUser(User admin, User user)`
`void`	`addValueLabels(User user, Variable variable, java.util.ArrayList<ValueLabel> valueLabels)`
`void`	`associateOntologyTermsWithVariable(User user, Variable variable, java.util.ArrayList<OntologyTerm> ontologyTerms)`
`void`	`associateSourceVariables(User user, DerivedVariable derivedVariable, java.util.ArrayList<Variable> sourceVariablesToAdd)`
`void`	`associateSupportingDocumentsWithVariable(User user, Variable variable, java.util.ArrayList<SupportingDocument> supportingDocuments)`
`void`	`checkValidAdministrator(User admin)`
`void`	`checkValidUser(User user)`
`void`	`clear(User admin)`
`void`	`clearAllChanges(User admin)`
`void`	`commitDatabaseChanges(java.sql.Connection connection)`
`void`	`deleteAliasFilePaths(User user, java.util.ArrayList<AliasFilePath> aliasFilePaths)`
`void`	`deleteAvailabilityStates(User user, java.util.ArrayList<AvailabilityState> availabilityStates)`
`void`	`deleteCategories(User user, java.util.ArrayList<Category> categories)`
`void`	`deleteCleaningStates(User user, java.util.ArrayList<CleaningState> cleaningStates)`
`void`	`deleteDerivedVariables(User user, java.util.ArrayList<DerivedVariable> derivedVariables)`
`void`	`deleteOntologyTerms(User user, java.util.ArrayList<OntologyTerm> ontologyTermsToDelete)`
`void`	`deleteRawVariables(User user, java.util.ArrayList<RawVariable> rawVariables)`
`void`	`deleteSupportingDocuments(User user, java.util.ArrayList<SupportingDocument> supportingDocuments)`
`void`	`deleteUsers(User admin, java.util.ArrayList<User> usersToDelete)`
`void`	`deleteValueLabels(User user, Variable variable, java.util.ArrayList<ValueLabel> valueLabels)`
`void`	`disassociateOntologyTermsFromVariable(User user, Variable variable, java.util.ArrayList<OntologyTerm> ontologyTerms)`
`void`	`disassociateSourceVariables(User user, DerivedVariable derivedVariable, java.util.ArrayList<Variable> sourceVariablesToDelete)` removes references to either `RawVariable` or `DerivedVariable` variables that were used to create a given derivedVariable
`void`	`disassociateSupportingDocumentsFromVariable(User user, Variable variable, java.util.ArrayList<SupportingDocument> supportingDocuments)`
`java.util.ArrayList<OntologyTerm>`	`filterOntologyTerms(User user, java.lang.String term, java.lang.String description)`
`java.util.ArrayList<SupportingDocument>`	`filterSupportingDocuments(User user, java.lang.String documentTitle, java.lang.String documentCode)`
`java.util.ArrayList<VariableSummary>`	`filterVariableSummaries(User user, java.lang.String searchText, java.lang.String year, java.lang.String category, VariableTypeFilter variableTypeFilter)`
`int`	`getAliasFilePathIdentifier(User user, Variable variable, AliasFilePath aliasFilePath)`
`java.util.ArrayList<AliasFilePath>`	`getAliasFilePaths(User user)` Methods for data libraries
`java.util.ArrayList<MacawChangeEvent>`	`getAllChanges(User admin)`
`java.util.ArrayList<OntologyTerm>`	`getAllOntologyTerms(User user)`
`java.util.ArrayList<SupportingDocument>`	`getAllSupportingDocuments(User user)`
`Variable`	`getAlternativeVariable(User user, Variable targetVariable)`
`int`	`getAvailabilityStateIdentifier(User user, Variable variable, AvailabilityState availabilityState)`
`java.util.ArrayList<AvailabilityState>`	`getAvailabilityStates(User user)` Methods for managing availability states
`java.util.ArrayList<Category>`	`getCategories(User user)`
`int`	`getCategoryIdentifier(User user, Variable variable, Category category)`
`java.util.ArrayList<MacawChangeEvent>`	`getChangeHistoryByUser(User user)`
`java.util.ArrayList<MacawChangeEvent>`	`getChangeHistoryForListChoices(User user)`
`java.util.ArrayList<MacawChangeEvent>`	`getChangeHistoryForSupportingDocument(User user, SupportingDocument supportingDocument)`
`java.util.ArrayList<MacawChangeEvent>`	`getChangeHistoryForValueLabels(User user, Variable variable)`
`java.util.ArrayList<MacawChangeEvent>`	`getChangeHistoryForVariable(User user, Variable variable)`
`int`	`getCleaningStateIdentifier(User user, Variable variable, CleaningState cleaningState)`
`java.util.ArrayList<CleaningState>`	`getCleaningStates(User user)` Methods for managing cleaning states
`Variable`	`getCompleteVariableData(User user, VariableSummary variableSummary)`
`int`	`getDerivedVariableIdentifier(User user, DerivedVariable derivedVariable)`
`java.lang.String`	`getFilePathFromAlias(User user, java.lang.String currentAlias)`
`int`	`getNumberOfConnections()`
`int`	`getOntologyTermIdentifier(User user, OntologyTerm ontologyTerm)`
`java.util.ArrayList<OntologyTerm>`	`getOntologyTerms(User user, Variable variable)`
`Variable`	`getOriginalVariable(User user, Variable variable)`
`int`	`getRawVariableIdentifier(User user, RawVariable rawVariable)`
`java.util.ArrayList<Variable>`	`getSourceVariables(User user, DerivedVariable derivedVariable)`
`java.lang.String[]`	`getStudyYears(User user)` retrieves a collection of unique years associated with at least one variable in the data repository.
`java.util.ArrayList<VariableSummary>`	`getSummaryDataForAllVariables(User user)` retrieves a collection of all variables managed by the system.
`int`	`getSupportingDocumentIdentifier(User user, SupportingDocument supportingDocument)`
`java.util.ArrayList<SupportingDocument>`	`getSupportingDocuments(User user, Variable variable)`
`int`	`getUserIdentifier(User admin, User user)`
`java.util.ArrayList<User>`	`getUsers(User admin)`
`int`	`getValueLabelIdentifier(User user, Variable variable, ValueLabel valueLabel)`
`java.util.ArrayList<ValueLabel>`	`getValueLabels(User user, Variable variable)`
`Variable`	`getVariable(User user, java.lang.String variableName)`
`void`	`initialiseConnection(java.sql.Connection connection)`
`void`	`rollBack(java.sql.Connection connection)`
`void`	`setAlternativeVariable(User user, Variable targetVariable, Variable alternativeVariable)`
`void`	`updateAliasFilePath(User user, AliasFilePath aliasFilePath)`
`void`	`updateAvailabilityState(User user, AvailabilityState availabilityState)`
`void`	`updateCategory(User user, Category category)`
`void`	`updateCleaningState(User user, CleaningState cleaningState)`
`void`	`updateDerivedVariable(User user, DerivedVariable derivedVariable)`
`void`	`updateOntologyTerm(User user, OntologyTerm ontologyTerm)`
`void`	`updateRawVariable(User user, RawVariable rawVariable)`
`void`	`updateSupportingDocument(User user, SupportingDocument supportingDocument)`
`void`	`updateUser(User admin, User user)`
`void`	`updateValueLabels(User user, Variable variable, java.util.ArrayList<ValueLabel> valueLabels)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail