de.unirostock.sems.caro

Class CaRoConverter

java.lang.Object

de.unirostock.sems.caro.CaRoConverter

Direct Known Subclasses:

CaToRo, RoToCa

public abstract class CaRoConverter
extends Object

The abstract class CaRoConverter defines the infrastructure for converting containers.

Author:

Martin Scharm

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	CA_RESTRICTIONS file name restrictions for combine archives.
protected de.unirostock.sems.cbarchive.CombineArchive	combineArchive The combine archive.
protected List<CaRoNotification>	notifications The notifications.
static org.jdom2.Namespace	RDF_NAMESPACE The RDF namespace.
protected org.apache.taverna.robundle.Bundle	researchObject The research object.
static String[]	RO_RESTRICTIONS file name restrictions for research objects.
protected File	sourceFile The source file.
static URI	URI_BF_MAIN_ENTRY The annotation to indicate a main entry.
static URI	URI_CA_RO_CONV The annotation to indicate that this was converted.
static URI	URI_MAIN_ENTRY The annotation to indicate main entries.
static URI	URI_OMEX_META The annotation to indicate omex meta.
static URI	URI_RO_CA_CONV The annotation to indicate that this was converted.
static URI	URI_RO_CONV_ANNOTATION The annotation to indicate it was an RO annotation.
static URI	URI_RO_COPY_ANNOTATION The annotation to indicate it was an annotation referenced in the RO.
static URI	URI_TURTLE_MIME The uri turtle file format.

Constructor Summary

Constructors

Constructor and Description
CaRoConverter(File sourceFile) The Constructor.

Method Summary

Modifier and Type	Method and Description
protected static de.unirostock.sems.cbarchive.meta.omex.VCard	agentToVCard(org.apache.taverna.robundle.manifest.Agent agent) Convert an RO agent to a CA vcard.
protected abstract boolean	closeSourceContainer() Open the source container.
protected abstract boolean	convert() Convert the container.
boolean	convertTo(File target) Convert this container to target.
List<CaRoNotification>	getNotifications() Gets the notifications occured during the conversion.
boolean	hasErrors() Checks for errors.
boolean	hasWarnings() Checks for warnings.
protected abstract boolean	openSourceContainer() Open the source container.
static boolean	sameVcard(de.unirostock.sems.cbarchive.meta.omex.VCard a, de.unirostock.sems.cbarchive.meta.omex.VCard b) Compare two VCards.
protected static org.apache.taverna.robundle.manifest.Agent	vcardToAgent(de.unirostock.sems.cbarchive.meta.omex.VCard vcard, List<CaRoNotification> notifications) Convert a CA vcard to an RO agent.
protected abstract boolean	write(File target) Write the container.

Methods inherited from class java.lang.Object

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

Field Detail

RO_RESTRICTIONS

public static final String[] RO_RESTRICTIONS

file name restrictions for research objects.

CA_RESTRICTIONS

public static final String[] CA_RESTRICTIONS

file name restrictions for combine archives.

RDF_NAMESPACE

public static org.jdom2.Namespace RDF_NAMESPACE

The RDF namespace.

URI_TURTLE_MIME

public static URI URI_TURTLE_MIME

The uri turtle file format.

URI_OMEX_META

public static URI URI_OMEX_META

The annotation to indicate omex meta.

URI_MAIN_ENTRY

public static URI URI_MAIN_ENTRY

The annotation to indicate main entries.

URI_BF_MAIN_ENTRY

public static URI URI_BF_MAIN_ENTRY

The annotation to indicate a main entry.

URI_RO_CONV_ANNOTATION

public static URI URI_RO_CONV_ANNOTATION

The annotation to indicate it was an RO annotation.

URI_RO_COPY_ANNOTATION

public static URI URI_RO_COPY_ANNOTATION

The annotation to indicate it was an annotation referenced in the RO.

URI_CA_RO_CONV

public static URI URI_CA_RO_CONV

The annotation to indicate that this was converted.

URI_RO_CA_CONV

public static URI URI_RO_CA_CONV

The annotation to indicate that this was converted.

sourceFile

protected File sourceFile

The source file.

combineArchive

protected de.unirostock.sems.cbarchive.CombineArchive combineArchive

The combine archive.

researchObject

protected org.apache.taverna.robundle.Bundle researchObject

The research object.

notifications

protected List<CaRoNotification> notifications

The notifications.

Constructor Detail

CaRoConverter

public CaRoConverter(File sourceFile)

The Constructor.

Parameters:

sourceFile - the source file

Method Detail

hasErrors

public boolean hasErrors()

Checks for errors.

Returns:

true, if the converter reported errors

hasWarnings

public boolean hasWarnings()

Checks for warnings. Might return false even if hasErrors() returns true.

Returns:

true, if the converter reported warnings

getNotifications

public List<CaRoNotification> getNotifications()

Gets the notifications occured during the conversion.

Returns:

the notifications

openSourceContainer

protected abstract boolean openSourceContainer()

Open the source container.

Returns:

true, if opening was successful

closeSourceContainer

protected abstract boolean closeSourceContainer()

Open the source container.

Returns:

true, if opening was successful

convert

protected abstract boolean convert()

Convert the container.

Returns:

true, if converting was successful

write

protected abstract boolean write(File target)

Write the container.

Parameters:

target - the target file to write to

Returns:

true, if exporting was successful

convertTo

public boolean convertTo(File target)

Convert this container to target.

Parameters:

target - the target file

Returns:

true, if converting was successful

agentToVCard

protected static de.unirostock.sems.cbarchive.meta.omex.VCard agentToVCard(org.apache.taverna.robundle.manifest.Agent agent)

Convert an RO agent to a CA vcard.

Parameters:

agent - the agent

Returns:

the vcard

vcardToAgent

protected static org.apache.taverna.robundle.manifest.Agent vcardToAgent(de.unirostock.sems.cbarchive.meta.omex.VCard vcard,
                                                                         List<CaRoNotification> notifications)

Convert a CA vcard to an RO agent.

Parameters:

vcard - the vcard

notifications - the notifications

Returns:

the agent

sameVcard

public static boolean sameVcard(de.unirostock.sems.cbarchive.meta.omex.VCard a,
                                de.unirostock.sems.cbarchive.meta.omex.VCard b)

Compare two VCards.

Parameters:

a - the first VCard

b - the second VCards

Returns:

true, if equal