ChangeFactory (jCOMODI 1.0.1 API)

java.lang.Object
- de.unirostock.sems.comodi.ChangeFactory

```
public class ChangeFactory
extends Object
```
The Class ChangeFactory creating and storing changes.
A new change can be obtained by calling one of the methods
providing the id of the subject(-node) encoding for the differences.
If you do not have any information of the type of change, you can also call the createChange(String) method to semantically just say it's a change..
The annotations can be obtained using getAnnotaions() (as Apache/Jena RDF model), getRdfXml() (encoded in RDF/XML), printTtl() (printed to sysout in TURTLE format), or printXml() (printed to sysout in RDF/XML format).
Author:

Martin Scharm

See Also:

The Change class and it's sub classes

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMODI_NS` The namespace of COMODI.
`static String`	`FOAF_NS` The friend-of-a-friend namespace.
`static String`	`ORE_NS` The Open Archives Initiative Object Reuse and Exchange (OAI-ORE) namespace.
`static String`	`PAV_NS` The PAV namespace.
`static String`	`PROV_NS` The PROV namespace.
`static String`	`RDF_NS` The RDF namespace.
`static String`	`RDFS_NS` The RDF schema namespace.

Constructor Summary

Constructors
Constructor and Description

ChangeFactory(URI baseUri)
The Constructor specifying the base URI of the file containing the changes.

Constructors
Constructor and Description
`ChangeFactory(URI baseUri)` The Constructor specifying the base URI of the file containing the changes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Change`	`createChange(String subjectId)` Creates a change encoded the subject with `subjectId`.
`protected Change`	`createChange(String subjectId, String type)` Creates a new Change object for a subject.
`Change`	`createDeletion(String subjectId)` Creates a deletion encoded the subject with `subjectId`.
`Change`	`createInsertion(String subjectId)` Creates a insertion encoded the subject with `subjectId`.
`Change`	`createMove(String subjectId)` Creates a move encoded the subject with `subjectId`.
`Change`	`createPermutationOfEntities(String subjectId)` Creates a permutation of entities (move) encoded the subject with `subjectId`.
`Change`	`createUpdate(String subjectId)` Creates a update encoded the subject with `subjectId`.
`org.apache.jena.rdf.model.Model`	`getAnnotaions()` Gets the annotations.
`URI`	`getBaseUri()` Gets the base URI for entities in this patch.
`List<Change>`	`getChanges()` Gets all registered changes.
`int`	`getNumChanges()` Gets the number changes produced by this factory.
`int`	`getNumStatements()` Gets the number of overall statements in all changes produced by this change factory.
`String`	`getRdfXml()` Compiles the assembled changes in an RDF/XML string.
`static String`	`getSubjectId(de.unirostock.sems.xmlutils.ds.DocumentNode node)` Gets the subject id of a DocumentNode.
`static String`	`getSubjectId(org.jdom2.Element node)` Gets the subject id of an Element.
`void`	`printTtl()` Prints the TURTLE serialisation to sysout.
`void`	`printXml()` Prints the RDF/XML serialisation to sysout.

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

- Field Detail
  - RDF_NS
```
public static final String RDF_NS
```
    The RDF namespace.
    
    See Also:
    
    Constant Field Values
  - RDFS_NS
```
public static final String RDFS_NS
```
    The RDF schema namespace.
    
    See Also:
    
    Constant Field Values
  - COMODI_NS
```
public static final String COMODI_NS
```
    The namespace of COMODI.
    
    See Also:
    
    Constant Field Values
  - PROV_NS
```
public static final String PROV_NS
```
    The PROV namespace.
    
    See Also:
    
    Constant Field Values
  - PAV_NS
```
public static final String PAV_NS
```
    The PAV namespace.
    
    See Also:
    
    Constant Field Values
  - FOAF_NS
```
public static final String FOAF_NS
```
    The friend-of-a-friend namespace.
    
    See Also:
    
    Constant Field Values
  - ORE_NS
```
public static final String ORE_NS
```
    The Open Archives Initiative Object Reuse and Exchange (OAI-ORE) namespace.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ChangeFactory
```
public ChangeFactory(URI baseUri)
```
    The Constructor specifying the base URI of the file containing the changes.
    
    Parameters:
    
    baseUri - the URI of the file containing the changes we'll be talking about
- Method Detail
  - getBaseUri
```
public URI getBaseUri()
```
    Gets the base URI for entities in this patch.
    
    Returns:
    
    the base URI
  - getChanges
```
public List<Change> getChanges()
```
    Gets all registered changes.
    
    Returns:
    
    the changes
  - getNumStatements
```
public int getNumStatements()
```
    Gets the number of overall statements in all changes produced by this change factory.
    
    Returns:
    
    the number statements
  - getNumChanges
```
public int getNumChanges()
```
    Gets the number changes produced by this factory.
    
    Returns:
    
    the number changes
  - createChange
```
public Change createChange(String subjectId)
```
    Creates a change encoded the subject with subjectId. Calling this method means you have no more information about the type of that change. Otherwise you should call on of the methods
    See getSubjectId(Element) and getSubjectId(DocumentNode) to conveniently obtain the subjectId of JDOM2 Elements and DocumentNodes.
    Parameters:
    
    subjectId - the id of the subject, ie. the change
    
    Returns:
    
    the change
    
    See Also:
    
    The Change class and it's sub classes
  - getSubjectId
```
public static String getSubjectId(org.jdom2.Element node)
```
    Gets the subject id of an Element. The subject id if will effectively be the element's id attribute value. That means, this node is supposed to have an id attribute.
    
    Parameters:
    
    node - the document node
    
    Returns:
    
    the subject id
    
    See Also:
    
    Element
  - getSubjectId
```
public static String getSubjectId(de.unirostock.sems.xmlutils.ds.DocumentNode node)
```
    Gets the subject id of a DocumentNode. The subject id if will effectively be the node's getId(). That means, this node is supposed to have an id attribute.
    
    Parameters:
    
    node - the document node
    
    Returns:
    
    the subject id
    
    See Also:
    
    DocumentNode
  - createChange
```
protected Change createChange(String subjectId,
                              String type)
```
    Creates a new Change object for a subject. This change will be of type type
    
    Parameters:
    
    subjectId - the subject id
    
    type - the type
    
    Returns:
    
    the change
    
    See Also:
    
    The Change class and it's sub classes
  - createInsertion
```
public Change createInsertion(String subjectId)
```
    Creates a insertion encoded the subject with subjectId. See getSubjectId(Element) and getSubjectId(DocumentNode) to conveniently obtain the subjectId of JDOM2 Elements and DocumentNodes.
    
    Parameters:
    
    subjectId - the id of the subject, ie. the change
    
    Returns:
    
    the change
    
    See Also:
    
    The Change class and it's sub classes, The Insertion class
  - createDeletion
```
public Change createDeletion(String subjectId)
```
    Creates a deletion encoded the subject with subjectId. See getSubjectId(Element) and getSubjectId(DocumentNode) to conveniently obtain the subjectId of JDOM2 Elements and DocumentNodes.
    
    Parameters:
    
    subjectId - the id of the subject, ie. the change
    
    Returns:
    
    the change
    
    See Also:
    
    The Change class and it's sub classes, The Deletion class
  - createUpdate
```
public Change createUpdate(String subjectId)
```
    Creates a update encoded the subject with subjectId. See getSubjectId(Element) and getSubjectId(DocumentNode) to conveniently obtain the subjectId of JDOM2 Elements and DocumentNodes.
    
    Parameters:
    
    subjectId - the id of the subject, ie. the change
    
    Returns:
    
    the change
    
    See Also:
    
    The Change class and it's sub classes, The Update class
  - createMove
```
public Change createMove(String subjectId)
```
    Creates a move encoded the subject with subjectId. See getSubjectId(Element) and getSubjectId(DocumentNode) to conveniently obtain the subjectId of JDOM2 Elements and DocumentNodes.
    
    Parameters:
    
    subjectId - the id of the subject, ie. the change
    
    Returns:
    
    the change
    
    See Also:
    
    The Change class and it's sub classes, The Move class
  - createPermutationOfEntities
```
public Change createPermutationOfEntities(String subjectId)
```
    Creates a permutation of entities (move) encoded the subject with subjectId. See getSubjectId(Element) and getSubjectId(DocumentNode) to conveniently obtain the subjectId of JDOM2 Elements and DocumentNodes.
    
    Parameters:
    
    subjectId - the id of the subject, ie. the change
    
    Returns:
    
    the change
    
    See Also:
    
    The Change class and it's sub classes, The PermutationOfEntities class
  - getRdfXml
```
public String getRdfXml()
```
    Compiles the assembled changes in an RDF/XML string.
    
    Returns:
    
    the RDF/XML string
  - getAnnotaions
```
public org.apache.jena.rdf.model.Model getAnnotaions()
```
    Gets the annotations.
    
    Returns:
    
    the annotations
  - printTtl
```
public void printTtl()
```
    Prints the TURTLE serialisation to sysout. Basically for debugging purposes.
  - printXml
```
public void printXml()
```
    Prints the RDF/XML serialisation to sysout. Basically for debugging purposes.

Class ChangeFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RDF_NS

RDFS_NS

COMODI_NS

PROV_NS

PAV_NS

FOAF_NS

ORE_NS

Constructor Detail

ChangeFactory

Method Detail

getBaseUri

getChanges

getNumStatements

getNumChanges

createChange

getSubjectId

getSubjectId

createChange

createInsertion

createDeletion

createUpdate

createMove

createPermutationOfEntities

getRdfXml

getAnnotaions

printTtl

printXml