gate.util.persistence

Class UpgradeXGAPP

java.lang.Object

gate.util.persistence.UpgradeXGAPP

@CreoleResource(tool=true,
                isPrivate=true,
                autoinstances=,
                name="Upgrade XGapp",
                comment="Upgrades an XGapp to use new style GATE plugins")
public class UpgradeXGAPP
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpgradeXGAPP.UpgradeAction
static class	UpgradeXGAPP.UpgradePath

Constructor Summary

Constructors

Constructor and Description
UpgradeXGAPP()

Method Summary

Modifier and Type	Method and Description
static org.eclipse.aether.version.Version	getDefaultSelection(org.eclipse.aether.resolution.VersionRangeResult vrr)
static org.eclipse.aether.resolution.VersionRangeResult	getPluginVersions(String group, String artifact)
static void	loadUpgradePaths(List<UpgradeXGAPP.UpgradePath> paths, URI xgappUri, File inputFile) Load a saved upgrade definition TSV file (such as would be written by saveUpgradePaths(java.util.List<gate.util.persistence.UpgradeXGAPP.UpgradePath>, java.net.URI, java.io.File)) and apply its instructions to the given list of upgrade paths extracted from another xgapp.
static void	main(String[] args)
static String	mapDirectoryNameToPlugin(String oldName) Attempts to map an old-style name of an 8.4 plugin under the GATE plugins folder into the corresponding Maven artifact ID under uk.ac.gate.plugins.
static void	saveUpgradePaths(List<UpgradeXGAPP.UpgradePath> paths, URI xgappUri, File outputFile) Save details of the given set of upgrade paths to a TSV file that can be re-used later when upgrading other apps.
static List<UpgradeXGAPP.UpgradePath>	suggest(org.jdom.Document doc)
static void	upgrade(org.jdom.Document doc, List<UpgradeXGAPP.UpgradePath> upgrades)

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeXGAPP

public UpgradeXGAPP()

Method Detail

getDefaultSelection

public static org.eclipse.aether.version.Version getDefaultSelection(org.eclipse.aether.resolution.VersionRangeResult vrr)

suggest

public static List<UpgradeXGAPP.UpgradePath> suggest(org.jdom.Document doc)
                                              throws IOException,
                                                     org.jdom.JDOMException

Throws:

IOException

org.jdom.JDOMException

mapDirectoryNameToPlugin

public static String mapDirectoryNameToPlugin(String oldName)

Attempts to map an old-style name of an 8.4 plugin under the GATE plugins folder into the corresponding Maven artifact ID under uk.ac.gate.plugins. In most cases this is a simple syntactic transformation but there are a couple of special cases.

Parameters:

oldName - the old plugin directory name

Returns:

the Maven artifact ID that corresponds to the old plugin in GATE 8.5 and later.

upgrade

public static void upgrade(org.jdom.Document doc,
                           List<UpgradeXGAPP.UpgradePath> upgrades)
                    throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

getPluginVersions

public static org.eclipse.aether.resolution.VersionRangeResult getPluginVersions(String group,
                                                                                 String artifact)

saveUpgradePaths

public static void saveUpgradePaths(List<UpgradeXGAPP.UpgradePath> paths,
                                    URI xgappUri,
                                    File outputFile)
                             throws IOException

Save details of the given set of upgrade paths to a TSV file that can be re-used later when upgrading other apps. Each line has either two or five fields:

• The oldPath, with $relpath$, $sysprop$ and $resourceshome expanded to absolute URIs
• The upgrade strategy (SKIP, PLUGIN_ONLY or UPGRADE).
• If the strategy is not SKIP then there are three more columns for the selected groupId, artifactId and version.

Parameters:

paths - the list of upgrade paths to persist

xgappUri - the location of the xgapp file we are upgrading, against which $relpath$ locations will be resolved.

outputFile - the file in which to save the output.

Throws:

IOException - if an error occurs writing the file.

loadUpgradePaths

public static void loadUpgradePaths(List<UpgradeXGAPP.UpgradePath> paths,
                                    URI xgappUri,
                                    File inputFile)
                             throws IOException

Load a saved upgrade definition TSV file (such as would be written by saveUpgradePaths(java.util.List<gate.util.persistence.UpgradeXGAPP.UpgradePath>, java.net.URI, java.io.File)) and apply its instructions to the given list of upgrade paths extracted from another xgapp.

Parameters:

paths - the list of upgrade paths to modify according to the saved instructions

xgappUri - the location of the xgapp from which paths were extracted, used to resolve any $relpath$ locations

inputFile - the TSV file of upgrade instructions

Throws:

IOException - if an error occurs while reading the file.

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception