org.corpus_tools.peppermodules.paula

Class Salt2PAULAMapper

java.lang.Object

org.corpus_tools.pepper.impl.PepperMapperImpl

org.corpus_tools.peppermodules.paula.Salt2PAULAMapper

All Implemented Interfaces:

FilenameFilter, org.corpus_tools.pepper.modules.PepperMapper, PAULAXMLDictionary

public class Salt2PAULAMapper
extends org.corpus_tools.pepper.impl.PepperMapperImpl
implements PAULAXMLDictionary, FilenameFilter

Maps SCorpusGraph objects to a folder structure and maps a SDocumentStructure to the necessary files containing the document data in PAULA notation.

Author:

Mario Frank, Florian Zipser

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_PREFIX a prefix for ids, which starts with a numeric
static String	NO_LAYER
static String	PATH_DTD

Fields inherited from class org.corpus_tools.pepper.impl.PepperMapperImpl

controller, progress, props

Fields inherited from interface org.corpus_tools.peppermodules.paula.PAULAXMLDictionary

ATT_BASE, ATT_FEAT_FEAT_DESC, ATT_FEAT_FEAT_EXP, ATT_FEAT_FEAT_TAR, ATT_FEAT_FEAT_VAL, ATT_HEADER_PAULA_ID, ATT_HEADER_TYPE, ATT_HREF, ATT_ID, ATT_MARK_MARK_TYPE, ATT_MULTI_FEAT_NAME, ATT_MULTI_FEAT_VALUE, ATT_PAULA_ID, ATT_REL_REL_TARGET, ATT_STRUCT_REL_TYPE, ATT_TYPE, ATT_VERSION, KW_AUDIO, LINE_SEPARATOR, MARK_LIST_CLOSE_TAG, PAULA_CLOSE_TAG, PAULA_FEAT_DOCTYPE_TAG, PAULA_MARK_DOCTYPE_TAG, PAULA_REL_DOCTYPE_TAG, PAULA_STRUCT_DOCTYPE_TAG, PAULA_TEXT_DOCTYPE_TAG, PAULA_TOKEN_FILE_CLOSING, STRUCT_LIST_CLOSE_TAG, TAG_FEAT_FEAT, TAG_FEAT_FEATLIST, TAG_HEADER, TAG_HEADER_XML, TAG_MARK_MARK, TAG_MARK_MARKLIST, TAG_MULTI_FEAT, TAG_MULTI_MULTIFEAT, TAG_MULTI_MULTIFEATLIST, TAG_PAULA, TAG_PAULA_OPEN, TAG_REL_REL, TAG_REL_RELLIST, TAG_STRUCT_REL, TAG_STRUCT_STRUCT, TAG_STRUCT_STRUCTLIST, TAG_TEXT_BODY, VALUE_MARK_MARK_TYPE, VERSION, XLINK_URI

Constructor Summary

Constructors

Constructor and Description
Salt2PAULAMapper()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(File f, String s) Implementation for FilenameFilter.
String	checkId(String id) Checks whether an id starts with a numeric, if true, the id will be prefixed with ID_PREFIX
File	generateFileName(org.corpus_tools.salt.graph.Label anno) Returns a filename, where to store the given SAnnotation.
File	generateFileName(org.corpus_tools.salt.core.SNode sNode) Returns a filename, where to store the given SNode.
File	generateFileName(org.corpus_tools.salt.core.SNode sNode, org.corpus_tools.salt.common.STextualDS sText) Returns a filename, where to store the given SNode.
File	generateFileName(org.corpus_tools.salt.core.SRelation<? extends org.corpus_tools.salt.core.SNode,? extends org.corpus_tools.salt.core.SNode> sRelation) Returns a filename, where to store the given SRelation.
String	generatePaulaType(org.corpus_tools.salt.graph.IdentifiableElement id) Generates a Paula type from the layers of passed SNode object.
String	generateXPointer(org.corpus_tools.salt.graph.IdentifiableElement target, File base) Generates an xpointer for a set of SNodes.
String	generateXPointer(List<? extends org.corpus_tools.salt.graph.IdentifiableElement> targets, File base) Generates an xpointer for a set of SIdentifiableElements.
org.eclipse.emf.common.util.URI	getResourcePath() Returns the path to the location of additional resources.
org.corpus_tools.pepper.common.DOCUMENT_STATUS	mapSCorpus() Maps SMetaAnnotation obejcts.
org.corpus_tools.pepper.common.DOCUMENT_STATUS	mapSDocument() OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.
void	mapSMedialDS() Maps audio data as data source.
void	mapSpans() Maps all SSpan objects.
void	mapTextualDataSources() Maps all STextualDS objects.
void	mapTokens() Maps all SToken objects.
void	setResourcePath(org.eclipse.emf.common.util.URI resources) Method for setting a reference to the path where the resources for the PAULAExporter (e.g.

Methods inherited from class org.corpus_tools.pepper.impl.PepperMapperImpl

addProgress, getCorpus, getDocument, getMappingResult, getMappingSubjects, getPepperMapperController, getProgress, getProperties, getResourceURI, initialize, readXMLResource, setCorpus, setDocument, setMappingResult, setPepperMapperController, setProgress, setProperties, setResourceURI

Methods inherited from class java.lang.Object

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

Field Detail

PATH_DTD

public static final String PATH_DTD

See Also:

Constant Field Values

ID_PREFIX

public static final String ID_PREFIX

a prefix for ids, which starts with a numeric

See Also:

Constant Field Values

NO_LAYER

public static final String NO_LAYER

See Also:

Constant Field Values

Constructor Detail

Salt2PAULAMapper

public Salt2PAULAMapper()

Method Detail

getResourcePath

public org.eclipse.emf.common.util.URI getResourcePath()

Returns the path to the location of additional resources.

setResourcePath

public void setResourcePath(org.eclipse.emf.common.util.URI resources)

Method for setting a reference to the path where the resources for the PAULAExporter (e.g. DTD-files) are located.

Parameters:

resources -

accept

public boolean accept(File f,
             String s)

Implementation for FilenameFilter. This is needed for fetching only the DTD-files from resource path for copying to output folder.

Specified by:

accept in interface FilenameFilter

mapSCorpus

public org.corpus_tools.pepper.common.DOCUMENT_STATUS mapSCorpus()

Maps SMetaAnnotation obejcts.

Specified by:

mapSCorpus in interface org.corpus_tools.pepper.modules.PepperMapper

Overrides:

mapSCorpus in class org.corpus_tools.pepper.impl.PepperMapperImpl

mapSDocument

public org.corpus_tools.pepper.common.DOCUMENT_STATUS mapSDocument()

OVERRIDE THIS METHOD FOR CUSTOMIZED MAPPING.

Specified by:

mapSDocument in interface org.corpus_tools.pepper.modules.PepperMapper

Overrides:

mapSDocument in class org.corpus_tools.pepper.impl.PepperMapperImpl

mapTextualDataSources

public void mapTextualDataSources()

Maps all STextualDS objects.

mapTokens

public void mapTokens()

Maps all SToken objects.

mapSMedialDS

public void mapSMedialDS()

Maps audio data as data source. When audio data are connected to tokens, a span for each connection is created and annotated with an audio annotation referencing the audio file. When no Token is connected to the audio source, a span is created for all tokens and an audio annotation is added to that span.

mapSpans

public void mapSpans()

Maps all SSpan objects.

checkId

public String checkId(String id)

Checks whether an id starts with a numeric, if true, the id will be prefixed with ID_PREFIX

generateXPointer

public String generateXPointer(org.corpus_tools.salt.graph.IdentifiableElement target,
                      File base)

Generates an xpointer for a set of SNodes.

Parameters:

targets -

Returns:

generateXPointer

public String generateXPointer(List<? extends org.corpus_tools.salt.graph.IdentifiableElement> targets,
                      File base)

Generates an xpointer for a set of SIdentifiableElements.

Parameters:

targets -

Returns:

generatePaulaType

public String generatePaulaType(org.corpus_tools.salt.graph.IdentifiableElement id)

Generates a Paula type from the layers of passed SNode object.

Parameters:

sNode -

Returns:

generateFileName

public File generateFileName(org.corpus_tools.salt.core.SNode sNode,
                    org.corpus_tools.salt.common.STextualDS sText)

Returns a filename, where to store the given SNode. The pattern, which is used to compute the files name is:
layers"."documentId"."TYPE_POSTFIX".xml"
If node belongs to several layers, they are sorted by name.

Parameters:

sNode - SNode to which a filename has to be generated

sText - STextualDS node, which is referred by this node (only in case of node is of type SToken)

Returns:

file name matching to given SNode

generateFileName

public File generateFileName(org.corpus_tools.salt.core.SNode sNode)

Returns a filename, where to store the given SNode. The pattern, which is used to compute the files name is:
layers"."documentId"."TYPE_POSTFIX".xml"
If node belongs to several layers, they are sorted by name.

Parameters:

sNode - SNode to which a filename has to be generated

Returns:

file name matching to given SNode

generateFileName

public File generateFileName(org.corpus_tools.salt.core.SRelation<? extends org.corpus_tools.salt.core.SNode,? extends org.corpus_tools.salt.core.SNode> sRelation)

Returns a filename, where to store the given SRelation.

Parameters:

sNode - SNode to which a filename has to be generated

Returns:

file name matching to given SNode

generateFileName

public File generateFileName(org.corpus_tools.salt.graph.Label anno)

Returns a filename, where to store the given SAnnotation.

Parameters:

sNode - SNode to which a filename has to be generated

Returns:

file name matching to given SNode