org.corpus_tools.annis.gui

Class Helper

java.lang.Object

org.corpus_tools.annis.gui.Helper

public class Helper
extends Object

Author:

thomas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Helper.CoveredMatchesCalculator Marks all nodes which are dominated by already marked nodes. 1.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.escape.Escaper	AQL_REGEX_VALUE_ESCAPER
static String	CORPUS_FONT
static String	CORPUS_FONT_FORCE
static String	DEFAULT_CONFIG

Constructor Summary

Constructors

Constructor and Description
Helper()

Method Summary

Modifier and Type	Method and Description
static void	addMatchToDocumentGraph(Match match, org.corpus_tools.salt.common.SDocumentGraph documentGraph)
static String	buildDocumentQuery(List<String> docPath, List<String> nodeAnnoFilter, boolean useRawText) Build a query that includes all (possible filtered by name) node of the document.
static Map<org.corpus_tools.salt.core.SNode,Long>	calculateMarkedAndCovered(org.corpus_tools.salt.common.SDocument doc, List<org.corpus_tools.salt.core.SNode> segNodes, String segmentationName)
static boolean	checkSLayer(String layerName, org.corpus_tools.salt.core.SNode node) Checks a SNode if it is member of a specific SLayer.
static boolean	containsRTLText(String str) Detects arabic characters in a string.
static String	convertExceptionToMessage(Throwable ex) Returns a formatted string containing the type of the exception, the message and the stacktrace.
static org.apache.commons.mail.MultiPartEmail	createEMailFromConfiguration(UIConfig config) Creates a pre-configured email object from the configuration.
static Map<org.corpus_tools.salt.common.SToken,Integer>	createToken2IndexMap(org.corpus_tools.salt.common.SDocumentGraph graph, org.corpus_tools.salt.common.STextualDS textualDS)
static String	encodeBase64URL(String val)
static elemental.json.JsonValue	encodeGeneric(Object v)
static String	generateCorpusLink(Set<String> corpora)
static ApiClient	getClient(com.vaadin.ui.UI ui)
static CorpusConfiguration	getCorpusConfig(String corpus, com.vaadin.ui.UI ui) Loads the corpus config of a specific corpus.
static List<String>	getCorpusPath(org.corpus_tools.salt.common.SCorpusGraph corpusGraph, org.corpus_tools.salt.common.SDocument doc)
static List<String>	getCorpusPath(String uri)
static CorpusConfiguration	getDefaultCorpusConfig()
static String	getDisplayName(org.springframework.security.oauth2.core.oidc.user.OidcUser user)
static com.google.common.collect.Range<Integer>	getLeftRightSpan(org.corpus_tools.salt.core.SNode node, org.corpus_tools.salt.common.SDocumentGraph graph, Map<org.corpus_tools.salt.common.SToken,Integer> token2index)
static Set<AnnoKey>	getMetaAnnotationNames(String corpus, com.vaadin.ui.UI ui)
static List<org.corpus_tools.salt.core.SMetaAnnotation>	getMetaData(String toplevelCorpusName, Optional<String> documentName, com.vaadin.ui.UI ui) Retrieve all the meta data for a given document of a corpus including the metadata of all corora in the path to the document.
static List<org.corpus_tools.salt.core.SMetaAnnotation>	getMetaDataDoc(String toplevelCorpusName, String documentName, com.vaadin.ui.UI ui) Retrieve the meta data for a given document of a corpus.
static String	getQName(AnnoKey key)
static String	getQName(Component c)
static String	getQualifiedName(org.corpus_tools.salt.core.SAnnotation anno) Get the qualified name separated by a single ":" when a namespace exists.
static List<org.corpus_tools.salt.core.SNode>	getSortedSegmentationNodes(String segName, org.corpus_tools.salt.common.SDocumentGraph graph) Calculates a SOrderRelation node chain of a SDocumentGraph.
static String	getSpannedText(org.corpus_tools.salt.common.SToken tok) Gets the spannend/covered text for a token.
static org.corpus_tools.salt.common.STextualDS	getTextualDSForNode(org.corpus_tools.salt.core.SNode node, org.corpus_tools.salt.common.SDocumentGraph graph) Finds the STextualDS for a given node.
static Set<String>	getTokenAnnotationLevelSet(org.corpus_tools.salt.common.SaltProject p)
static Set<String>	getTokenAnnotationLevelSet(org.corpus_tools.salt.common.SDocumentGraph graph)
static Set<String>	getToplevelCorpusNames(org.corpus_tools.salt.common.SaltProject p) Gets all names of a corpus from a salt project.
static Optional<org.springframework.security.oauth2.core.oidc.user.OidcUser>	getUser(org.springframework.security.core.context.SecurityContext context)
static Optional<org.springframework.security.oauth2.core.oidc.user.OidcUser>	getUser(com.vaadin.ui.UI ui)
static Map<String,String>	parseFragment(String fragment) Parses the fragment.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG

public static final String DEFAULT_CONFIG

See Also:

Constant Field Values

CORPUS_FONT_FORCE

public static final String CORPUS_FONT_FORCE

See Also:

Constant Field Values

CORPUS_FONT

public static final String CORPUS_FONT

See Also:

Constant Field Values

AQL_REGEX_VALUE_ESCAPER

public static final com.google.common.escape.Escaper AQL_REGEX_VALUE_ESCAPER

Constructor Detail

Helper

public Helper()

Method Detail

getCorpusPath

public static List<String> getCorpusPath(org.corpus_tools.salt.common.SCorpusGraph corpusGraph,
                                         org.corpus_tools.salt.common.SDocument doc)

getCorpusPath

public static List<String> getCorpusPath(String uri)

calculateMarkedAndCovered

public static Map<org.corpus_tools.salt.core.SNode,Long> calculateMarkedAndCovered(org.corpus_tools.salt.common.SDocument doc,
                                                                                   List<org.corpus_tools.salt.core.SNode> segNodes,
                                                                                   String segmentationName)

convertExceptionToMessage

public static String convertExceptionToMessage(Throwable ex)

Returns a formatted string containing the type of the exception, the message and the stacktrace.

Parameters:

ex - Exception

Returns:

message

getClient

public static ApiClient getClient(com.vaadin.ui.UI ui)

getMetaAnnotationNames

public static Set<AnnoKey> getMetaAnnotationNames(String corpus,
                                                  com.vaadin.ui.UI ui)
                                           throws ApiException

Throws:

ApiException

getQName

public static String getQName(AnnoKey key)

getQName

public static String getQName(Component c)

createToken2IndexMap

public static Map<org.corpus_tools.salt.common.SToken,Integer> createToken2IndexMap(org.corpus_tools.salt.common.SDocumentGraph graph,
                                                                                    org.corpus_tools.salt.common.STextualDS textualDS)

encodeGeneric

public static elemental.json.JsonValue encodeGeneric(Object v)

encodeBase64URL

public static String encodeBase64URL(String val)

generateCorpusLink

public static String generateCorpusLink(Set<String> corpora)

getCorpusConfig

public static CorpusConfiguration getCorpusConfig(String corpus,
                                                  com.vaadin.ui.UI ui)

Loads the corpus config of a specific corpus.

Parameters:

corpus - The name of the corpus, for which the config is fetched.

Returns:

A CorpusConfig object, which wraps a Properties object. This Properties object stores the corpus configuration as simple key-value pairs.

getDefaultCorpusConfig

public static CorpusConfiguration getDefaultCorpusConfig()

getLeftRightSpan

public static com.google.common.collect.Range<Integer> getLeftRightSpan(org.corpus_tools.salt.core.SNode node,
                                                                        org.corpus_tools.salt.common.SDocumentGraph graph,
                                                                        Map<org.corpus_tools.salt.common.SToken,Integer> token2index)

getMetaData

public static List<org.corpus_tools.salt.core.SMetaAnnotation> getMetaData(String toplevelCorpusName,
                                                                           Optional<String> documentName,
                                                                           com.vaadin.ui.UI ui)

Retrieve all the meta data for a given document of a corpus including the metadata of all corora in the path to the document.

Parameters:

toplevelCorpusName - Specifies the the toplevel corpus

documentName - Specifies the document or leave empty if only the corpus meta data should be fetched.

Returns:

Returns also the metada of the all parent corpora. There must be at least one of them.

getMetaDataDoc

public static List<org.corpus_tools.salt.core.SMetaAnnotation> getMetaDataDoc(String toplevelCorpusName,
                                                                              String documentName,
                                                                              com.vaadin.ui.UI ui)

Retrieve the meta data for a given document of a corpus.

Parameters:

toplevelCorpusName - specifies the toplevel corpus

documentName - specifies the document.

Returns:

returns only the meta data for a single document.

getQualifiedName

public static String getQualifiedName(org.corpus_tools.salt.core.SAnnotation anno)

Get the qualified name separated by a single ":" when a namespace exists.

Parameters:

anno - annotation

Returns:

qualified name

getUser

public static Optional<org.springframework.security.oauth2.core.oidc.user.OidcUser> getUser(com.vaadin.ui.UI ui)

getUser

public static Optional<org.springframework.security.oauth2.core.oidc.user.OidcUser> getUser(org.springframework.security.core.context.SecurityContext context)

getDisplayName

public static String getDisplayName(org.springframework.security.oauth2.core.oidc.user.OidcUser user)

addMatchToDocumentGraph

public static void addMatchToDocumentGraph(Match match,
                                           org.corpus_tools.salt.common.SDocumentGraph documentGraph)

getSortedSegmentationNodes

public static List<org.corpus_tools.salt.core.SNode> getSortedSegmentationNodes(String segName,
                                                                                org.corpus_tools.salt.common.SDocumentGraph graph)

Calculates a SOrderRelation node chain of a SDocumentGraph.

If no segmentation name is set, a list of sorted SToken will be returned.

Parameters:

segName - The segmentation name, for which the chain is computed.

graph - The salt document graph, which is traversed for the segmentation.

Returns:

Returns a List of SNode, which is sorted by the SOrderRelation.

containsRTLText

public static boolean containsRTLText(String str)

Detects arabic characters in a string.

Every character is checked, if its bit representation lies between: [1425, 1785] | [64286, 65019] | [65136, 65276]

Parameters:

str - The string to be checked.

Returns:

returns true, if arabic characters are detected.

getSpannedText

public static String getSpannedText(org.corpus_tools.salt.common.SToken tok)

Gets the spannend/covered text for a token. This will get all STextualRelation edges for a SToken from the SDocumentGraph and calculates the appropiate substring from the STextualDS.

Parameters:

tok - The SToken which is overlapping the text sequence.

Returns:

An empty String object, if there is no STextualRelation

getTextualDSForNode

public static org.corpus_tools.salt.common.STextualDS getTextualDSForNode(org.corpus_tools.salt.core.SNode node,
                                                                          org.corpus_tools.salt.common.SDocumentGraph graph)

Finds the STextualDS for a given node. The node must dominate a token of this text.

Parameters:

node - Salt node to find the textual data source for

graph - document graph

Returns:

textual datasource or null if not connected to one

getTokenAnnotationLevelSet

public static Set<String> getTokenAnnotationLevelSet(org.corpus_tools.salt.common.SaltProject p)

getTokenAnnotationLevelSet

public static Set<String> getTokenAnnotationLevelSet(org.corpus_tools.salt.common.SDocumentGraph graph)

checkSLayer

public static boolean checkSLayer(String layerName,
                                  org.corpus_tools.salt.core.SNode node)

Checks a SNode if it is member of a specific SLayer.

Parameters:

layerName - Specifies the layername to check.

node - Specifies the node to check.

Returns:

true - it is true when the name of layername corresponds to the name of any label of the SNode.

getToplevelCorpusNames

public static Set<String> getToplevelCorpusNames(org.corpus_tools.salt.common.SaltProject p)

Gets all names of a corpus from a salt project.

Parameters:

p - Salt project

Returns:

returns an empty list if project is empty or null.

parseFragment

public static Map<String,String> parseFragment(String fragment)

Parses the fragment. Fragments have the form key1=value&key2=test ...

Parameters:

fragment - fragment to parse

Returns:

a map with the keys and values of the fragment

buildDocumentQuery

public static String buildDocumentQuery(List<String> docPath,
                                        List<String> nodeAnnoFilter,
                                        boolean useRawText)

Build a query that includes all (possible filtered by name) node of the document.

Parameters:

docPath - the path of the document

nodeAnnoFilter - A list of node annotation names for filtering the nodes or null if no filtering should be applied.

useRawText - If true, only extract the original raw text

Returns:

createEMailFromConfiguration

public static org.apache.commons.mail.MultiPartEmail createEMailFromConfiguration(UIConfig config)
                                                                           throws org.apache.commons.mail.EmailException,
                                                                                  UnknownHostException

Creates a pre-configured email object from the configuration.

Parameters:

config -

Returns:

An email with server and from information set.

Throws:

org.apache.commons.mail.EmailException

UnknownHostException - Thrown when the "mailFrom" property is not set and the localhost host name can't be determined.