|
1
|
/**
|
|
2
|
* Copyright (C) 2009 EDIT
|
|
3
|
* European Distributed Institute of Taxonomy
|
|
4
|
* http://www.e-taxonomy.eu
|
|
5
|
*
|
|
6
|
* The contents of this file are subject to the Mozilla Public License Version 1.1
|
|
7
|
* See LICENSE.TXT at the top of this package for the full license terms.
|
|
8
|
*/
|
|
9
|
package eu.etaxonomy.cdm.database.update;
|
|
10
|
|
|
11
|
import eu.etaxonomy.cdm.common.monitor.IProgressMonitor;
|
|
12
|
import eu.etaxonomy.cdm.database.ICdmDataSource;
|
|
13
|
|
|
14
|
/**
|
|
15
|
* Class which represents a CDM schema version step. See {@link CdmUpdater}
|
|
16
|
* for further documentation or implementing classes for examples.
|
|
17
|
*
|
|
18
|
* @see CdmUpdater
|
|
19
|
* @see ISchemaUpdaterStep
|
|
20
|
* @see ISchemaUpdater
|
|
21
|
* @see ITermUpdaterStep
|
|
22
|
*
|
|
23
|
* @author a.mueller
|
|
24
|
* @since 09.2010
|
|
25
|
*/
|
|
26
|
public interface ISchemaUpdater extends IUpdater<ISchemaUpdater>{
|
|
27
|
|
|
28
|
/**
|
|
29
|
* Invokes this CDM schema updater and updates the schema up to the current CDM
|
|
30
|
* schema version. Throws an exception if this updater's target version does
|
|
31
|
* not equal the current CDM schema version.
|
|
32
|
*
|
|
33
|
* @param datasource the datasource
|
|
34
|
* @param monitor the progress monitor and event listener
|
|
35
|
* @param caseType the
|
|
36
|
* @param result
|
|
37
|
* @return
|
|
38
|
* @throws Exception
|
|
39
|
*/
|
|
40
|
@Override
|
|
41
|
public void invoke(ICdmDataSource datasource, IProgressMonitor monitor,
|
|
42
|
CaseType caseType, SchemaUpdateResult result) throws Exception;
|
|
43
|
|
|
44
|
/**
|
|
45
|
* Invokes this CDM schema updater and updates the schema up to the given
|
|
46
|
* target version. Throws an exception if this updaters target version does
|
|
47
|
* not equal the given target version.
|
|
48
|
* @param targetVersion
|
|
49
|
* @param datasource the datasource
|
|
50
|
* @param monitor the progress monitor and event listener
|
|
51
|
* @result the accumlated result of the schema update
|
|
52
|
* @return
|
|
53
|
* @throws Exception
|
|
54
|
*/
|
|
55
|
@Override
|
|
56
|
public void invoke(String targetVersion, ICdmDataSource datasource,
|
|
57
|
IProgressMonitor monitor, CaseType caseType, SchemaUpdateResult result) throws Exception;
|
|
58
|
|
|
59
|
public String getTargetVersion();
|
|
60
|
|
|
61
|
}
|