de.hu_berlin.german.korpling.rst

Interface RSTDocument

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

RSTDocumentImpl

public interface RSTDocument
extends org.eclipse.emf.ecore.EObject

A representation of the model object ' Document'.

The following features are supported:

• Name
• Segments
• Groups
• Relations

See Also:

RSTPackage.getRSTDocument()

Method Summary

Methods

Modifier and Type	Method and Description
Relation	createRelation(AbstractNode parent, AbstractNode child, String name, String type) Creates a Relation object, sets its parent, child, name and type value to the given ones and adds the created relation to this RSTDocument object.
org.eclipse.emf.common.util.EList<Group>	getGroups() Returns the value of the 'Groups' containment reference list.
org.eclipse.emf.common.util.EList<Relation>	getIncomingRelations(String id)
String	getName() Returns the value of the 'Name' attribute.
Relation	getOutgoingRelation(String id)
org.eclipse.emf.common.util.EList<Relation>	getOutgoingRelations(String id)
org.eclipse.emf.common.util.EList<Relation>	getRelations() Returns the value of the 'Relations' containment reference list.
org.eclipse.emf.common.util.EList<Segment>	getSegments() Returns the value of the 'Segments' containment reference list.
void	setName(String value) Sets the value of the ' Name ' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getName

String getName()

Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), RSTPackage.getRSTDocument_Name()

setName

void setName(String value)

Sets the value of the ' Name ' attribute.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

getName()

getSegments

org.eclipse.emf.common.util.EList<Segment> getSegments()

Returns the value of the 'Segments' containment reference list. The list contents are of type Segment. It is bidirectional and its opposite is ' Document'.

If the meaning of the 'Segments' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Segments' containment reference list.

See Also:

RSTPackage.getRSTDocument_Segments(), Segment.getDocument()

getGroups

org.eclipse.emf.common.util.EList<Group> getGroups()

Returns the value of the 'Groups' containment reference list. The list contents are of type Group. It is bidirectional and its opposite is ' Document'.

If the meaning of the 'Groups' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Groups' containment reference list.

See Also:

RSTPackage.getRSTDocument_Groups(), Group.getDocument()

getRelations

org.eclipse.emf.common.util.EList<Relation> getRelations()

Returns the value of the 'Relations' containment reference list. The list contents are of type Relation. It is bidirectional and its opposite is ' Documents'.

If the meaning of the 'Relations' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Relations' containment reference list.

See Also:

RSTPackage.getRSTDocument_Relations(), Relation.getDocuments()

getIncomingRelations

org.eclipse.emf.common.util.EList<Relation> getIncomingRelations(String id)

getOutgoingRelation

Relation getOutgoingRelation(String id)

getOutgoingRelations

org.eclipse.emf.common.util.EList<Relation> getOutgoingRelations(String id)

createRelation

Relation createRelation(AbstractNode parent,
                      AbstractNode child,
                      String name,
                      String type)

Creates a Relation object, sets its parent, child, name and type value to the given ones and adds the created relation to this RSTDocument object.

Returns:

returns the created object