InMemoryVariableManager (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.demo
Class InMemoryVariableManager

java.lang.Object
  macaw.persistenceLayer.demo.InMemoryCurationConceptManager
      macaw.persistenceLayer.demo.InMemoryVariableManager

public class InMemoryVariableManager
extends InMemoryCurationConceptManager
extends InMemoryCurationConceptManager

manages instances of Variable in memory. It also supports adding and deleting associations between a Variable and:

>=1 SupportingDocument records.
>=1 OntologyTerm records.
>=1 Variable records (for DerivedVariable records only

In the Macaw data entry forms, users add or remove associations through list management buttons. Other variable associations are less obvious. Each variable is also associated with:

1 Category (in future it will be >=1 category)
1 AvailabilityState
1 CleaningState
1 AliasFilePath

In the Macaw forms, these items are shown to users in a drop down list. Items in this list can be edited through separate data entry forms (see CategoryStateEditor,CleaningStateEditor, AvailabilityStateEditor, AliasFilePath.

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)

Field Summary

Fields inherited from class macaw.persistenceLayer.demo.InMemoryCurationConceptManager
`log`

Constructor Summary
`InMemoryVariableManager(InMemoryChangeEventManager changeEventManager, InMemoryListChoiceManager listChoiceManager, InMemoryOntologyTermManager ontologyTermManager, InMemorySupportingDocumentsManager supportingDocumentsManager)`

Method Summary
`void`	`addDerivedVariable(User user, DerivedVariable derivedVariable)`
`void`	`addRawVariable(User user, RawVariable rawVariable)`
`void`	`addVariable(User user, Variable variable)`
`void`	`associateOntologyTerms(User user, Variable variable, java.util.ArrayList<OntologyTerm> ontologyTermsToAssociate)`
`void`	`associateSourceVariables(User user, DerivedVariable derivedVariable, java.util.ArrayList<Variable> sourceVariablesToAdd)`
`void`	`associateSupportingDocuments(User user, Variable variable, java.util.ArrayList<SupportingDocument> supportingDocumentsToAdd)`
`void`	`checkVariableExists(Variable variable)`
`void`	`clear()`
`void`	`deleteDerivedVariables(User user, java.util.ArrayList<DerivedVariable> derivedVariablesToDelete)`
`void`	`deleteOntologyTermReferences(java.util.ArrayList<OntologyTerm> targetOntologyTerms)`
`void`	`deleteRawVariables(User user, java.util.ArrayList<RawVariable> rawVariablesToDelete)`
`void`	`disassociateOntologyTerms(User user, Variable variable, java.util.ArrayList<OntologyTerm> ontologyTermsToDisassociate)`
`void`	`disassociateSourceVariables(User user, DerivedVariable derivedVariable, java.util.ArrayList<Variable> sourceVariablesToDelete)`
`void`	`disassociateSupportingDocuments(User user, Variable variable, java.util.ArrayList<SupportingDocument> supportingDocumentsToDelete)`
`Variable`	`getAlternativeVariable(Variable targetVariable)`
`java.util.ArrayList<OntologyTerm>`	`getAssociatedOntologyTerms(User user, Variable variable)` public Variable getVariable(User user, String variableName) throws MacawException { if (variableName == null) { return null; } for (Variable variable : variables) { if (variable.getName().equals(variableName) == true) { return variable; } } return null; }
`java.util.ArrayList<Category>`	`getCategoriesForVariable(User user, java.lang.String variableName)`
`Variable`	`getCompleteVariableData(User user, VariableSummary variableSummary)`
`int`	`getDerivedVariableIdentifier(User user, DerivedVariable derivedVariable)`
`Variable`	`getOriginalVariable(Variable variable)`
`java.util.ArrayList<Variable>`	`getOriginalVariables(User user)`
`int`	`getRawVariableIdentifier(User user, RawVariable rawVariable)`
`java.util.ArrayList<Variable>`	`getSourceVariables(User user, DerivedVariable derivedVariable)`
`java.lang.String[]`	`getStudyYears(User user)`
`java.util.ArrayList<VariableSummary>`	`getSummaryDataForAllVariables(User user)`
`java.util.ArrayList<SupportingDocument>`	`getSupportingDocuments(User user, Variable variable)`
`java.util.ArrayList<ValueLabel>`	`getValueLabels(User user, Variable variable)`
`Variable`	`getVariable(User user, java.lang.String variableName)`
`java.lang.String[]`	`getVariableNames(User user)`
`java.util.ArrayList<Variable>`	`getVariables(User user)`
`java.util.ArrayList<VariableSummary>`	`getVariableSummariesForCategory(User user, java.lang.String categoryName)`
`void`	`setAlternativeVariable(User user, Variable targetVariable, Variable updatedAlternativeVariable)`
`void`	`updateDerivedVariable(User user, DerivedVariable revisedDerivedVariable)`
`void`	`updateOntologyTermReferences(OntologyTerm targetOntologyTerm)`
`void`	`updateRawVariable(User user, RawVariable revisedRawVariable)`

Methods inherited from class macaw.persistenceLayer.demo.InMemoryCurationConceptManager
`registerChangeEvent, registerChangeEvents, setLog`

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

Constructor Detail