SaltUtil (salt-api 3.3.9 API)

java.lang.Object
- org.corpus_tools.salt.util.SaltUtil

```
public class SaltUtil
extends Object
```
This class contains a set of helpful methods.

Author:

florian

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FEAT_NAME` Name for `SFeature` to store the name of a node, relation, graph or label.
`static String`	`FEAT_NAME_QNAME` Qualified name for `SFeature` to store the name of a node, relation, graph or label.
`static String`	`FEAT_SDATA` The name of the `SFeature` for the data label for textual sources, etc..
`static String`	`FEAT_SDATA_QNAME` Qualified name name of the `SFeature` for the data label for textual sources, etc..
`static String`	`FEAT_SDOCUMENT` Name for `SFeature` to store the `SDocument` corresponding to a `SDocumentGraph` object
`static String`	`FEAT_SDOCUMENT_GRAPH` Name for `SFeature` to store the `SDocumentGraph` in a `SDocument` object
`static String`	`FEAT_SDOCUMENT_GRAPH_LOCATION` Name for `SFeature` to store the uri reference of a `SDocumentGraph` in a `SDocument`
`static String`	`FEAT_SDOCUMENT_GRAPH_LOCATION_QNAME` Qualified name name for `SFeature` to store the uri reference of a `SDocumentGraph` in a `SDocument`
`static String`	`FEAT_SDOCUMENT_GRAPH_QNAME` Qualified name for `SFeature` to store the `SDocumentGraph` in a `SDocument` object
`static String`	`FEAT_SDOCUMENT_QNAME` Qualified name for `SFeature` to store the `SDocument` corresponding to a `SDocumentGraph` object
`static String`	`FEAT_SEND` The name of the `SFeature` for the end value.
`static String`	`FEAT_SEND_QNAME` The qualified name of the name of the `SFeature` for the end value.
`static String`	`FEAT_SMEDIA_REFERNCE` The name of the `SFeature` for the reference to an audio file.
`static String`	`FEAT_SMEDIA_REFERNCE_QNAME` The qualified name of the name of the `SFeature` for the reference to an audio file.
`static String`	`FEAT_SSTART` The name of the `SFeature` for the start value.
`static String`	`FEAT_SSTART_QNAME` The qualified name of the name of the `SFeature` for the start value.
`static String`	`FEAT_TYPE` Name for `SFeature` to store the type of a relation.
`static String`	`FEAT_TYPE_QNAME` Qualified name for `SFeature` to store the type of a relation.
`static String`	`FEAT_VALUE_DATATYPE` Name for `SFeature` to store the type of a labels value.
`static String`	`FILE_ENDING_DOT` The ending of a dot file.
`static String`	`FILE_ENDING_SALT_XML` The ending of a Salt XML file.
`static String`	`FILE_SALT_PROJECT` Default name of the saltProject file.
`static String`	`IDX_ID_LAYER` name of index for relating ids and layers
`static String`	`IDX_ID_NODES` name of index for relating ids and nodes
`static String`	`IDX_ID_NODES_INVERSE` name of index for relating ids and nodes (inverse)
`static String`	`IDX_ID_RELATIONS` name of index for relating ids and relations
`static String`	`IDX_ID_RELATIONS_INVERSE` name of index for relating ids and relations (inverse)
`static String`	`IDX_IN_RELATIONS` name of index for relating node ids and incoming relations
`static String`	`IDX_NODETYPE` name of index for node-types
`static String`	`IDX_OUT_RELATIONS` name of index for relating node ids and outgoing relations
`static String`	`IDX_RELATIONTYPE` name of index for relation-types
`static String`	`LABEL_ID` Name of `Label` to store the identifier of a node, relation, graph or layer.
`static String`	`LABEL_ID_QNAME` Qualified name of `Label` to store the identifier of a node, relation, graph or layer.
`static String`	`NAMESPACE_SEPERATOR` Separator between namespace and name: qname= NAMESPACE "::" NAME.
`static String`	`SALT_NAMESPACE` default name for of derived namespace-attribute
`static String`	`SALT_NULL_VALUE` A NULL value as String.
`static String`	`SALT_SCHEME` The URI scheme for corpus pathes.
`static String`	`SEMANTICS_CAT` name for `SCatAnnotation`
`static String`	`SEMANTICS_LEMMA` name for `SLemmaAnnotation`
`static String`	`SEMANTICS_POS` name for `SPOSAnnotation`
`static String`	`SEMANTICS_SENTENCE` name for `SSentenceAnnotation`
`static String`	`SEMANTICS_TYPE` value for `STypeAnnotation`
`static String`	`SEMANTICS_UNIT` name for `SWordAnnotation` and `SSentenceAnnotation`
`static String`	`SEMANTICS_WORD` value for `SWordAnnotation`

Constructor Summary

Constructors
Constructor and Description

SaltUtil()

Constructors
Constructor and Description
`SaltUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`belongsToCorpusStructure(Object element)` Returns whether specified Salt element is part of the corpus structure.
`static <S> Diff.Builder<S>`	`compare(S saltElement)` Creates a builder to have a fluent api for comparing two `SDocumentGraph`s or `SCorpusGraph`s.
`static String`	`createQName(String namespace, String name)` Returns the concatenation of a labels namespace and a labels name as a qualified name: qname= NAMESPACE "::" NAME.
`static org.eclipse.emf.common.util.URI`	`createSaltURI(String path)` When specified corpus path already contains salt schema, then specified corpus path is returned.
`static org.eclipse.emf.common.util.URI`	`createSaltURI(org.eclipse.emf.common.util.URI path)` When specified corpus path already contains salt schema, then specified corpus path is returned.
`static <P extends Label> P`	`getAnnotation(Integer idx, Set<P> annotations)` Returns the annotation at position idx in the passed set of annotations.
`static String`	`getGlobalId(Identifier id)` Returns a global ID for the passed object (either if `Identifier` belongs to `SDocument` or `SCorpus` object).
`static <T> boolean`	`isNotNullOrEmpty(Collection<T> collection)` Checks whether a collection is not null nor empty
`static <T> boolean`	`isNullOrEmpty(Collection<T> collection)` Checks whether a collection is null or empty
`static Object`	`load(org.eclipse.emf.common.util.URI location)` Loads an object coming from a SaltXML (.
`static SaltProject`	`loadCompleteSaltProject(org.eclipse.emf.common.util.URI location)` Loads a SaltProject from given uri and returns it as object structure.
`static SCorpusGraph`	`loadCorpusGraph(org.eclipse.emf.common.util.URI corpusPath)` Loads the given SaltXML file (.
`static SCorpusGraph`	`loadCorpusGraph(org.eclipse.emf.common.util.URI corpusPath, Integer idxOfSCorpusGraph)` Loads the given SaltXML file (.
`static SDocumentGraph`	`loadDocumentGraph(org.eclipse.emf.common.util.URI location)` Loads a `SDocumentGraph` object and returns it.
`static List<Object>`	`loadObjects(org.eclipse.emf.common.util.URI location)` Loads a list of root objects coming from a SaltXML (.
`static SaltProject`	`loadSaltProject(org.eclipse.emf.common.util.URI location)` Loads a SaltProject from given uri and returns it as object structure.
`static void`	`moveAnnotations(SAnnotationContainer from, SAnnotationContainer to)` Moves all `SAnnotation` objects from `from` to `to`.
`static void`	`moveCorpusGraph(SCorpusGraph source, SCorpusGraph target)` Moves the content of `source` to `target`.
`static void`	`moveMetaAnnotations(SAnnotationContainer from, SAnnotationContainer to)` Moves all `SMetaAnnotation` objects from `from` to `to`.
`static void`	`save_DOT(Object saltObject, org.eclipse.emf.common.util.URI location)` This method stores a Salt model in the dot syntax (see: http://www.graphviz.org/) in a file.
`static void`	`saveCorpusGraph_DOT(SCorpusGraph corpusGraph, org.eclipse.emf.common.util.URI location)` Stores a `SCorpusGraph` into DOT file.
`static void`	`saveCorpusGraph(SCorpusGraph corpusGraph, org.eclipse.emf.common.util.URI location)` Persists the passed `SCorpusGraph` object in a file at the passed location.
`static void`	`saveDocumentGraph_DOT(SDocumentGraph documentGraph, org.eclipse.emf.common.util.URI location)` Stores a `SDocumentGraph` into DOT file.
`static void`	`saveDocumentGraph(SDocumentGraph documentGraph, org.eclipse.emf.common.util.URI location)` Persists the passed `SDocumentGraph` object in a SaltXML file at the passed location.
`static void`	`saveSaltProject(SaltProject saltProject, org.eclipse.emf.common.util.URI location)` Persists the passed `SaltProject` object in a SaltXML file at the passed location.
`static org.apache.commons.lang3.tuple.Pair<String,String>`	`splitQName(String qName)` Splits the passed qName into a namespace and a name.
`static Collection<String[]>`	`unmarshalAnnotation(String marshalledString)` Splits an annotation string of the form 'namespace::name=value (,namespace::name=value)* into a collection of (namespace, name, value).
`static <T> Validator.Builder<T>`	`validate(T saltObject)` Validates a salt project, a document structure or a corpus structure.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SALT_SCHEME
```
public static final String SALT_SCHEME
```
    The URI scheme for corpus pathes.
    
    See Also:
    
    Constant Field Values
  - FILE_ENDING_SALT_XML
```
public static final String FILE_ENDING_SALT_XML
```
    The ending of a Salt XML file.
    
    See Also:
    
    Constant Field Values
  - FILE_ENDING_DOT
```
public static final String FILE_ENDING_DOT
```
    The ending of a dot file.
    
    See Also:
    
    Constant Field Values
  - FILE_SALT_PROJECT
```
public static final String FILE_SALT_PROJECT
```
    Default name of the saltProject file.
    
    See Also:
    
    Constant Field Values
  - SALT_NAMESPACE
```
public static final String SALT_NAMESPACE
```
    default name for of derived namespace-attribute
    
    See Also:
    
    Constant Field Values
  - NAMESPACE_SEPERATOR
```
public static final String NAMESPACE_SEPERATOR
```
    Separator between namespace and name: qname= NAMESPACE "::" NAME.
    
    See Also:
    
    Constant Field Values
  - SALT_NULL_VALUE
```
public static final String SALT_NULL_VALUE
```
    A NULL value as String.
    
    See Also:
    
    Constant Field Values
  - IDX_NODETYPE
```
public static final String IDX_NODETYPE
```
    name of index for node-types
    
    See Also:
    
    Constant Field Values
  - IDX_RELATIONTYPE
```
public static final String IDX_RELATIONTYPE
```
    name of index for relation-types
    
    See Also:
    
    Constant Field Values
  - IDX_ID_NODES
```
public static final String IDX_ID_NODES
```
    name of index for relating ids and nodes
    
    See Also:
    
    Constant Field Values
  - IDX_ID_NODES_INVERSE
```
public static final String IDX_ID_NODES_INVERSE
```
    name of index for relating ids and nodes (inverse)
    
    See Also:
    
    Constant Field Values
  - IDX_ID_RELATIONS
```
public static final String IDX_ID_RELATIONS
```
    name of index for relating ids and relations
    
    See Also:
    
    Constant Field Values
  - IDX_ID_RELATIONS_INVERSE
```
public static final String IDX_ID_RELATIONS_INVERSE
```
    name of index for relating ids and relations (inverse)
    
    See Also:
    
    Constant Field Values
  - IDX_ID_LAYER
```
public static final String IDX_ID_LAYER
```
    name of index for relating ids and layers
    
    See Also:
    
    Constant Field Values
  - IDX_OUT_RELATIONS
```
public static final String IDX_OUT_RELATIONS
```
    name of index for relating node ids and outgoing relations
    
    See Also:
    
    Constant Field Values
  - IDX_IN_RELATIONS
```
public static final String IDX_IN_RELATIONS
```
    name of index for relating node ids and incoming relations
    
    See Also:
    
    Constant Field Values
  - LABEL_ID
```
public static final String LABEL_ID
```
    Name of Label to store the identifier of a node, relation, graph or layer.
    
    See Also:
    
    Constant Field Values
  - LABEL_ID_QNAME
```
public static final String LABEL_ID_QNAME
```
    Qualified name of Label to store the identifier of a node, relation, graph or layer.
    
    See Also:
    
    Constant Field Values
  - FEAT_VALUE_DATATYPE
```
public static final String FEAT_VALUE_DATATYPE
```
    Name for SFeature to store the type of a labels value.
    
    See Also:
    
    Constant Field Values
  - FEAT_NAME
```
public static final String FEAT_NAME
```
    Name for SFeature to store the name of a node, relation, graph or label.
    
    See Also:
    
    Constant Field Values
  - FEAT_NAME_QNAME
```
public static final String FEAT_NAME_QNAME
```
    Qualified name for SFeature to store the name of a node, relation, graph or label.
    
    See Also:
    
    Constant Field Values
  - FEAT_TYPE
```
public static final String FEAT_TYPE
```
    Name for SFeature to store the type of a relation.
    
    See Also:
    
    Constant Field Values
  - FEAT_TYPE_QNAME
```
public static final String FEAT_TYPE_QNAME
```
    Qualified name for SFeature to store the type of a relation.
    
    See Also:
    
    Constant Field Values
  - FEAT_SDOCUMENT_GRAPH
```
public static final String FEAT_SDOCUMENT_GRAPH
```
    Name for SFeature to store the SDocumentGraph in a SDocument object
    
    See Also:
    
    Constant Field Values
  - FEAT_SDOCUMENT_GRAPH_QNAME
```
public static final String FEAT_SDOCUMENT_GRAPH_QNAME
```
    Qualified name for SFeature to store the SDocumentGraph in a SDocument object
    
    See Also:
    
    Constant Field Values
  - FEAT_SDOCUMENT
```
public static final String FEAT_SDOCUMENT
```
    Name for SFeature to store the SDocument corresponding to a SDocumentGraph object
    
    See Also:
    
    Constant Field Values
  - FEAT_SDOCUMENT_QNAME
```
public static final String FEAT_SDOCUMENT_QNAME
```
    Qualified name for SFeature to store the SDocument corresponding to a SDocumentGraph object
    
    See Also:
    
    Constant Field Values
  - FEAT_SDOCUMENT_GRAPH_LOCATION
```
public static final String FEAT_SDOCUMENT_GRAPH_LOCATION
```
    Name for SFeature to store the uri reference of a SDocumentGraph in a SDocument
    
    See Also:
    
    Constant Field Values
  - FEAT_SDOCUMENT_GRAPH_LOCATION_QNAME
```
public static final String FEAT_SDOCUMENT_GRAPH_LOCATION_QNAME
```
    Qualified name name for SFeature to store the uri reference of a SDocumentGraph in a SDocument
    
    See Also:
    
    Constant Field Values
  - FEAT_SMEDIA_REFERNCE
```
public static final String FEAT_SMEDIA_REFERNCE
```
    The name of the SFeature for the reference to an audio file.
    
    See Also:
    
    Constant Field Values
  - FEAT_SMEDIA_REFERNCE_QNAME
```
public static final String FEAT_SMEDIA_REFERNCE_QNAME
```
    The qualified name of the name of the SFeature for the reference to an audio file.
    
    See Also:
    
    Constant Field Values
  - FEAT_SSTART
```
public static final String FEAT_SSTART
```
    The name of the SFeature for the start value.
    
    See Also:
    
    Constant Field Values
  - FEAT_SSTART_QNAME
```
public static final String FEAT_SSTART_QNAME
```
    The qualified name of the name of the SFeature for the start value.
    
    See Also:
    
    Constant Field Values
  - FEAT_SEND
```
public static final String FEAT_SEND
```
    The name of the SFeature for the end value.
    
    See Also:
    
    Constant Field Values
  - FEAT_SEND_QNAME
```
public static final String FEAT_SEND_QNAME
```
    The qualified name of the name of the SFeature for the end value.
    
    See Also:
    
    Constant Field Values
  - FEAT_SDATA
```
public static final String FEAT_SDATA
```
    The name of the SFeature for the data label for textual sources, etc..
    
    See Also:
    
    Constant Field Values
  - FEAT_SDATA_QNAME
```
public static final String FEAT_SDATA_QNAME
```
    Qualified name name of the SFeature for the data label for textual sources, etc..
    
    See Also:
    
    Constant Field Values
  - SEMANTICS_CAT
```
public static final String SEMANTICS_CAT
```
    name for SCatAnnotation
    
    See Also:
    
    Constant Field Values
  - SEMANTICS_POS
```
public static final String SEMANTICS_POS
```
    name for SPOSAnnotation
    
    See Also:
    
    Constant Field Values
  - SEMANTICS_LEMMA
```
public static final String SEMANTICS_LEMMA
```
    name for SLemmaAnnotation
    
    See Also:
    
    Constant Field Values
  - SEMANTICS_SENTENCE
```
public static final String SEMANTICS_SENTENCE
```
    name for SSentenceAnnotation
    
    See Also:
    
    Constant Field Values
  - SEMANTICS_TYPE
```
public static final String SEMANTICS_TYPE
```
    value for STypeAnnotation
    
    See Also:
    
    Constant Field Values
  - SEMANTICS_WORD
```
public static final String SEMANTICS_WORD
```
    value for SWordAnnotation
    
    See Also:
    
    Constant Field Values
  - SEMANTICS_UNIT
```
public static final String SEMANTICS_UNIT
```
    name for SWordAnnotation and SSentenceAnnotation
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SaltUtil
```
public SaltUtil()
```
- Method Detail
  - createQName
```
public static String createQName(String namespace,
                                 String name)
```
    Returns the concatenation of a labels namespace and a labels name as a qualified name: qname= NAMESPACE "::" NAME.
    
    Parameters:
    
    namespace - the namespace of a label
    
    name - the name of a label
  - splitQName
```
public static org.apache.commons.lang3.tuple.Pair<String,String> splitQName(String qName)
```
    Splits the passed qName into a namespace and a name.
    
    Returns:
    
    Pair.getLeft() is the namespace, whereas Pair.getRight() is the name
  - createSaltURI
```
public static org.eclipse.emf.common.util.URI createSaltURI(org.eclipse.emf.common.util.URI path)
```
    When specified corpus path already contains salt schema, then specified corpus path is returned. Otherwise a absolute new corpus path which is equal to specified corpus path is returned, which is augmented for salt scheme. When specified corpusPath is null, null is returned.
    
    Parameters:
    
    path -
    
    Returns:
  - createSaltURI
```
public static org.eclipse.emf.common.util.URI createSaltURI(String path)
```
    When specified corpus path already contains salt schema, then specified corpus path is returned. Otherwise a absolute new corpus path which is equal to specified corpus path is returned, which is augmented for salt scheme. When specified corpusPath is null, null is returned.
    
    Parameters:
    
    path - path to an element
    
    Returns:
    
    corresponding Salt URI
  - getGlobalId
```
public static String getGlobalId(Identifier id)
```
    Returns a global ID for the passed object (either if Identifier belongs to SDocument or SCorpus object). A global id only can be returned, if the element is contained in a SCorpusGraph object.
    
    Parameters:
    
    id - Object to retrieve global id.
    
    Returns:
    
    String value for global id, if one is given.
  - load
```
public static Object load(org.eclipse.emf.common.util.URI location)
```
    Loads an object coming from a SaltXML (.FILE_ENDING_SALT_XML) and returns it. If multiple objects are contained in the file it will only load the first one.
    
    Parameters:
    
    location - URI to SaltXML file containing the object or null if the fule does not contain any objects.
    
    Returns:
    
    loaded object
    
    See Also:
    
    loadObjects(...): similar function that returns all the objects of a file.
  - loadObjects
```
public static List<Object> loadObjects(org.eclipse.emf.common.util.URI location)
```
    Loads a list of root objects coming from a SaltXML (. FILE_ENDING_SALT_XML) and returns it.
    
    Parameters:
    
    objectURI - URI to SaltXML file containing the object
    
    Returns:
    
    loaded objects
  - moveCorpusGraph
```
public static void moveCorpusGraph(SCorpusGraph source,
                                   SCorpusGraph target)
```
    Moves the content of source to target. Caution: Object contained in source will be moved, which from target to source, which will mean, that object are not content of source any more after using moveCorpusGraph(SCorpusGraph, SCorpusGraph).
    
    Parameters:
    
    source - SCorpusGraph delivering the content to moveSCorpusGraph
    
    target - SCorpusGraph object to where the content will be moved
  - saveDocumentGraph
```
public static void saveDocumentGraph(SDocumentGraph documentGraph,
                                     org.eclipse.emf.common.util.URI location)
```
    Persists the passed SDocumentGraph object in a SaltXML file at the passed location.
    
    Parameters:
    
    documentGraph - SDocumentGraph object to persist
    
    location - location of where to persist object as URI
  - loadDocumentGraph
```
public static SDocumentGraph loadDocumentGraph(org.eclipse.emf.common.util.URI location)
```
    Loads a SDocumentGraph object and returns it. The location of where to find the SaltXML containing the SDocumentGraph object is given by the passed URI object.
    
    Parameters:
    
    location - location of SaltXML to load SDocumentGraph object.
  - saveCorpusGraph
```
public static void saveCorpusGraph(SCorpusGraph corpusGraph,
                                   org.eclipse.emf.common.util.URI location)
```
    Persists the passed SCorpusGraph object in a file at the passed location. The relation between all SDocuments and their SDocumentGraph will be removed.
    
    Parameters:
    
    corpusGraph - SCorpusGraph object to persist
    
    location - location of where to persist object as URI
  - loadCorpusGraph
```
public static SCorpusGraph loadCorpusGraph(org.eclipse.emf.common.util.URI corpusPath)
```
    Loads the given SaltXML file (.) into this object. If the given SaltXML file does not contain a SCorpusGraph object persisting, an exception will be thrown. If the SaltXML file contains persistings for more than one SCorpusGraph object, the first one will be loaded.
    
    Parameters:
    
    corpusPath - the URI to locate the SaltXML file
    
    Returns:
  - loadCorpusGraph
```
public static SCorpusGraph loadCorpusGraph(org.eclipse.emf.common.util.URI corpusPath,
                                           Integer idxOfSCorpusGraph)
```
    Loads the given SaltXML file (.) into this object. If the given SaltXML file does not contain a SCorpusGraph object persisting, an exception will be thrown. The parameter idxOfSCorpusGraph determines which object shall be load, in case of the given SaltXML file contains more than one persisting of SCorpusGraph objects.
    
    Parameters:
    
    corpusPath - the URI to locate the SaltXML file
    
    idxOfSCorpusGraph - number of graph to be load, note that the list of graphs starts with 0
    
    Returns:
  - saveSaltProject
```
public static void saveSaltProject(SaltProject saltProject,
                                   org.eclipse.emf.common.util.URI location)
```
    Persists the passed SaltProject object in a SaltXML file at the passed location. The relation between all SDocuments and their SDocumentGraph will be removed.
    
    Parameters:
    
    saltProject - SaltProject object to persist
    
    location - location of where to persist object as URI
  - loadCompleteSaltProject
```
public static SaltProject loadCompleteSaltProject(org.eclipse.emf.common.util.URI location)
```
    Loads a SaltProject from given uri and returns it as object structure.
    
    Parameters:
    
    location - location to the Salt project file
    
    Returns:
    
    returns a saltProject, which is filled with data coming from corpus in uri
  - loadSaltProject
```
public static SaltProject loadSaltProject(org.eclipse.emf.common.util.URI location)
```
    Loads a SaltProject from given uri and returns it as object structure. This does not load the document graphs which are to the SaltProject from the disk. To load the entire project use loadCompleteSaltProject(URI) or call SDocument.loadDocumentGraph() on each document to load the actual document graph.
    
    Parameters:
    
    location - location to the Salt project file
    
    Returns:
    
    returns a saltProject, which is filled with data coming from corpus in uri
  - saveCorpusGraph_DOT
```
public static void saveCorpusGraph_DOT(SCorpusGraph corpusGraph,
                                       org.eclipse.emf.common.util.URI location)
```
    Stores a SCorpusGraph into DOT file.
    
    Parameters:
    
    corpusGraph - the corpus graph to be stored
    
    location - the location to where the corpus graph is stored
  - saveDocumentGraph_DOT
```
public static void saveDocumentGraph_DOT(SDocumentGraph documentGraph,
                                         org.eclipse.emf.common.util.URI location)
```
    Stores a SDocumentGraph into DOT file.
    
    Parameters:
    
    documentGraph - the document graph to be stored
    
    location - the location to where the document graph is stored
  - save_DOT
```
public static void save_DOT(Object saltObject,
                            org.eclipse.emf.common.util.URI location)
```
    This method stores a Salt model in the dot syntax (see: http://www.graphviz.org/) in a file. The stored dot graph can be visualized via the Graphviz toolbox (see: http://www.graphviz.org/) into a bunch of graphical formats like jpeg, png, svg etc..
    In case of a SaltProject like the following is stored:
```
 |-----------------------------------------------|
 | SaltProject:                                  |
 |-----------------------------------------------|
 | corpus-structure 0      | corpus-structure 1  |
 |                         |                     |
 |          c1             |       c1            |
 |        /     \          |       |             |
 |       c2      c3        |       d1            |
 |   /   |   \   |   \     |                     |
 |  d1   d2  d3  d4  d5    |                     |
 |-----------------------------------------------|
 
```
    A structure like the following is created:
```
 
  |-0
  | |-c1
  | | |-c2
  | |   |-d1.dot
  | |   |-d2.dot
  | |   |-d3.dot
  | | |-c3
  | |   |-d4.dot
  | |   |-d5.dot
  | |-0.dot
  |-1
    |-c1
    | |-d1.dot
    |-1.dot
 
```
  - getAnnotation
```
public static <P extends Label> P getAnnotation(Integer idx,
                                                Set<P> annotations)
```
    Returns the annotation at position idx in the passed set of annotations.
    
    Parameters:
    
    idx - position of the annotation to be returned
    
    annotations - set of annotations
    
    Returns:
    
    annotation at position idx
  - moveAnnotations
```
public static void moveAnnotations(SAnnotationContainer from,
                                   SAnnotationContainer to)
```
    Moves all SAnnotation objects from from to to.
    
    Parameters:
    
    from - SAnnotatableElement object from which SAnnotation object should be moved
    
    to - SAnnotatableElement object to which SAnnotation object should be moved
  - moveMetaAnnotations
```
public static void moveMetaAnnotations(SAnnotationContainer from,
                                       SAnnotationContainer to)
```
    Moves all SMetaAnnotation objects from from to to.
    
    Parameters:
    
    from - SMetaAnnotatableElement object from which SMetaAnnotation object should be moved
    
    to - SMetaAnnotatableElement object to which SMetaAnnotation object should be moved
  - unmarshalAnnotation
```
public static Collection<String[]> unmarshalAnnotation(String marshalledString)
```
    Splits an annotation string of the form 'namespace::name=value (,namespace::name=value)* into a collection of (namespace, name, value).
    
    Parameters:
    
    marshalledString - the annotation string to be unmarschalled
    
    Returns:
    
    a collection of (namespace, name, value).
  - compare
```
public static <S> Diff.Builder<S> compare(S saltElement)
```
    Creates a builder to have a fluent api for comparing two SDocumentGraphs or SCorpusGraphs.
```
 compare(graph1).with(graph2).useOption(key, value).andCheckIsomorphie().
 or
 compare(graph1).with(graph2).useOption(key, value).andFindDiffs().
 
```
  - isNullOrEmpty
```
public static <T> boolean isNullOrEmpty(Collection<T> collection)
```
    Checks whether a collection is null or empty
    
    Parameters:
    
    list -
    
    Returns:
  - isNotNullOrEmpty
```
public static <T> boolean isNotNullOrEmpty(Collection<T> collection)
```
    Checks whether a collection is not null nor empty
    
    Parameters:
    
    list -
    
    Returns:
  - belongsToCorpusStructure
```
public static boolean belongsToCorpusStructure(Object element)
```
    Returns whether specified Salt element is part of the corpus structure.
    
    Parameters:
    
    element - Salt element
    
    Returns:
    
    true, when Salt element is a part of the corpus structure, false otherwise
  - validate
```
public static <T> Validator.Builder<T> validate(T saltObject)
```
    Validates a salt project, a document structure or a corpus structure.
    
    Parameters:
    
    saltObject - Salt object to be validated
    
    Returns:

Class SaltUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SALT_SCHEME

FILE_ENDING_SALT_XML

FILE_ENDING_DOT

FILE_SALT_PROJECT

SALT_NAMESPACE

NAMESPACE_SEPERATOR

SALT_NULL_VALUE

IDX_NODETYPE

IDX_RELATIONTYPE

IDX_ID_NODES

IDX_ID_NODES_INVERSE

IDX_ID_RELATIONS

IDX_ID_RELATIONS_INVERSE

IDX_ID_LAYER

IDX_OUT_RELATIONS

IDX_IN_RELATIONS

LABEL_ID

LABEL_ID_QNAME

FEAT_VALUE_DATATYPE

FEAT_NAME

FEAT_NAME_QNAME

FEAT_TYPE

FEAT_TYPE_QNAME

FEAT_SDOCUMENT_GRAPH

FEAT_SDOCUMENT_GRAPH_QNAME

FEAT_SDOCUMENT

FEAT_SDOCUMENT_QNAME

FEAT_SDOCUMENT_GRAPH_LOCATION

FEAT_SDOCUMENT_GRAPH_LOCATION_QNAME

FEAT_SMEDIA_REFERNCE

FEAT_SMEDIA_REFERNCE_QNAME

FEAT_SSTART

FEAT_SSTART_QNAME

FEAT_SEND

FEAT_SEND_QNAME

FEAT_SDATA

FEAT_SDATA_QNAME

SEMANTICS_CAT

SEMANTICS_POS

SEMANTICS_LEMMA

SEMANTICS_SENTENCE

SEMANTICS_TYPE

SEMANTICS_WORD

SEMANTICS_UNIT

Constructor Detail

SaltUtil

Method Detail

createQName

splitQName

createSaltURI

createSaltURI

getGlobalId

load

loadObjects

moveCorpusGraph

saveDocumentGraph

loadDocumentGraph

saveCorpusGraph

loadCorpusGraph

loadCorpusGraph

saveSaltProject

loadCompleteSaltProject

loadSaltProject

saveCorpusGraph_DOT

saveDocumentGraph_DOT

save_DOT

getAnnotation

moveAnnotations

moveMetaAnnotations

unmarshalAnnotation

compare

isNullOrEmpty

isNotNullOrEmpty

belongsToCorpusStructure