CommunicationChannel (alps.java.api 0.7)

alps.java.api.ALPS.ALPSModelElements.ALPSSIDComponents.CommunicationChannel

Alle implementierten Schnittstellen:: ICommunicationChannel, IALPSSIDComponent, IALPSModelElement, ICapsuleCallback, IGraphCallback, IParseablePASSProcessModelElement, IPASSProcessModelElement, IInteractionDescribingComponent, IContainableElement<IModelLayer>, IHasSimple2DVisualizationLine, IValueChangedObserver<IPASSProcessModelElement>, IValueChangedPublisher<IPASSProcessModelElement>

public class CommunicationChannel extends ALPSSIDComponent implements ICommunicationChannel

Method that represents an abstract communication channel. Instances of this class are by default BiDirectional channels, but can be changed to UniDirectional channels using setIsUniDirectional(boolean) From abstract pass ont: It defines a possible message exchange between two subjects. (a recommendation for a message). It states that there IS communication between the two but not what exactly. Usually, comunication channels are bi-directional, however the can be limited to one direction. Similar to the abstract message connector, if two abstract or interface subjects are connected via a channel they mey be joined on an implementation layer.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen alps.java.api.StandardPASS.PASSProcessModelElement
PASSProcessModelElement.ConnectedElementsSetSpecification, PASSProcessModelElement.ObserverInformType
Feldübersicht

Felder

Modifizierer und Typ

Feld

Beschreibung

protected boolean

channelIsUniDirectional

private final String

className

Name of the class, needed for parsing

protected ISubject

correspondentA

protected ISubject

correspondentB

private double

has2DPageRatio

private double

hasRelative2D_BeginX

private double

hasRelative2D_BeginY

private double

hasRelative2D_EndX

private double

hasRelative2D_EndY

(Package privat) Logger

Log

private boolean

oldIsUniDirectionalValue

private List<ISimple2DVisualizationPathPoint>

pathPoints

Von Klasse geerbte Felder alps.java.api.StandardPASS.PassProcessModelElements.InteractionDescribingComponent
layer

Von Klasse geerbte Felder alps.java.api.StandardPASS.PASSProcessModelElement
additionalAttributeTriples, additionalElements, additionalIncompleteTriples, BASE_URI_PLACEHOLDER, CANNOT_PARSE, comments, customLocale, EXAMPLE_BASE_URI, exportGraph, exportSubjectNodeName, guid, modelComponentID, modelComponentLabels, observerList, parsingStarted
Konstruktorübersicht

Konstruktoren

Konstruktor

Beschreibung

CommunicationChannel()

CommunicationChannel(IModelLayer layer)

CommunicationChannel(IModelLayer layer, String labelForID, ISubject correspondentA, ISubject correspondentB, boolean isUniDirectional, String comment, String additionalLabel, List<IIncompleteTriple> additionalAttribute)
Methodenübersicht

Modifizierer und Typ

Methode

Beschreibung

void

addSimple2DPathPoint(ISimple2DVisualizationPathPoint point)

double

get2DPageRatio()

The relative positions of the simple 2D Vizualiations are given in % of page hight and width No absolut values are given but a page ratio that defines whether it is a wide or tall format

String

getClassName()

public static CultureInfo customCulture = new CultureInfo("en-US"); static PASSProcessModelElement(){ customCulture.NumberFormat.NumberDecimalSeparator = "

ISubject

getCorrespondentA()

ISubject

getCorrespondentB()

org.apache.commons.lang3.tuple.Pair<ISubject,ISubject>

getCorrespondents()

protected String

getExportTag()

IParseablePASSProcessModelElement

getParsedInstance()

double

getRelative2DBeginX()

double

getRelative2DBeginY()

double

getRelative2DEndX()

double

getRelative2DEndY()

List<ISimple2DVisualizationPathPoint>

getSimple2DPathPoints()

boolean

isUniDirectional()

Returns whether this channel is a Bi- or UniDirectionalCommunicationChannel.

protected boolean

parseAttribute(String predicate, String objectContent, String lang, String dataType, IParseablePASSProcessModelElement element)

Gets called while parsing a triple from a set of triples where this element is subject.

void

set2DPageRatio(double has2DPageRatio)

void

setCorrespondentA(ISubject correspondentA)

void

setCorrespondentA(ISubject correspondentA, int removeCascadeDepth)

void

setCorrespondentB(ISubject correspondentB)

void

setCorrespondentB(ISubject correspondentB, int removeCascadeDepth)

void

setCorrespondents(ISubject correspondentA, ISubject correspondentB)

void

setCorrespondents(ISubject correspondentA, ISubject correspondentB, int removeCascadeDepth)

void

setIsUniDirectional(boolean isUniDirectional)

Sets the direction of the channel.

void

setRelative2DBeginX(double relative2DBeginX)

void

setRelative2DBeginY(double relative2DBeginY)

void

setRelative2DEndX(double relative2DEndX)

void

setRelative2DEndY(double relative2DEndY)

Von Klasse geerbte Methoden alps.java.api.StandardPASS.PassProcessModelElements.InteractionDescribingComponent
getAllConnectedElements, getContainedBy, getDictionaryOfAllAvailableElements, removeFromContainer, setContainedBy

Von Klasse geerbte Methoden alps.java.api.StandardPASS.PASSProcessModelElement
addComment, addComment, addElementWithUnspecifiedRelation, addIncompleteTriples, addModelComponentLabel, addModelComponentLabel, addTriple, addTriple, addTriples, canParse, clearComments, clearModelComponentLabels, completeIncompleteTriple, completeObject, containsTriple, createUniqueModelComponentID, createUniqueModelComponentID, createUniqueModelComponentID, equals, getBaseURI, getComments, getElementsWithUnspecifiedRelation, getIncompleteTriple, getIncompleteTriples, getModelComponentID, getModelComponentLabels, getModelComponentLabelsAsStrings, getModelComponentLabelsAsStrings, getSubjectName, getTriple, getTriples, getUriModelComponentID, informObserverAboutConnectedObjects, informObserverAboutConnectedObjects, invalidateTriplesContainingString, notifyModelComponentIDChanged, notifyTriple, parseAttribute, parseAttribute, publishElementAdded, publishElementRemoved, publishElementRemoved, publishNewModelComponentID, register, removeElementWithUnspecifiedRelation, removeFromEverything, removeFromEverything, removeModelComponentLabel, removeTriple, replaceTriple, setElementsWithUnspecifiedRelation, setExportGraph, setExportXMLName, setModelComponentID, setModelComponentLabels, successfullyParsedElement, unregister, unregister, updateAdded, updateRemoved, updateRemoved

Von Klasse geerbte Methoden java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Von Schnittstelle geerbte Methoden alps.java.api.util.IContainableElement
getContainedBy, removeFromContainer, setContainedBy

Von Schnittstelle geerbte Methoden alps.java.api.StandardPASS.IPASSProcessModelElement
addComment, addElementWithUnspecifiedRelation, addModelComponentLabel, clearComments, clearModelComponentLabels, createUniqueModelComponentID, createUniqueModelComponentID, createUniqueModelComponentID, getComments, getElementsWithUnspecifiedRelation, getModelComponentID, getModelComponentLabels, getModelComponentLabelsAsStrings, getModelComponentLabelsAsStrings, getUriModelComponentID, removeElementWithUnspecifiedRelation, removeFromEverything, removeFromEverything, removeModelComponentLabel, setElementsWithUnspecifiedRelation, setModelComponentID, setModelComponentLabels

Von Schnittstelle geerbte Methoden alps.java.api.util.IValueChangedObserver
notifyModelComponentIDChanged, updateAdded, updateRemoved, updateRemoved

Von Schnittstelle geerbte Methoden alps.java.api.util.IValueChangedPublisher
register, unregister, unregister

Felddetails
- className
  
  private final String className
  
  Name of the class, needed for parsing
  Siehe auch:
  
  Konstantenfeldwerte
- Log
  
  Logger Log
- correspondentA
  
  protected ISubject correspondentA
- correspondentB
  
  protected ISubject correspondentB
- channelIsUniDirectional
  
  protected boolean channelIsUniDirectional
- oldIsUniDirectionalValue
  
  private boolean oldIsUniDirectionalValue
- has2DPageRatio
  
  private double has2DPageRatio
- hasRelative2D_BeginX
  
  private double hasRelative2D_BeginX
- hasRelative2D_BeginY
  
  private double hasRelative2D_BeginY
- hasRelative2D_EndX
  
  private double hasRelative2D_EndX
- hasRelative2D_EndY
  
  private double hasRelative2D_EndY
- pathPoints
  
  private List<ISimple2DVisualizationPathPoint> pathPoints
Konstruktordetails
- CommunicationChannel
  
  public CommunicationChannel()
- CommunicationChannel
  
  public CommunicationChannel(IModelLayer layer, String labelForID, ISubject correspondentA, ISubject correspondentB, boolean isUniDirectional, String comment, String additionalLabel, List<IIncompleteTriple> additionalAttribute)
- CommunicationChannel
  
  public CommunicationChannel(IModelLayer layer)
Methodendetails
- getClassName
  
  public String getClassName()
  
  Beschreibung aus Klasse kopiert: PASSProcessModelElement
  
  public static CultureInfo customCulture = new CultureInfo("en-US"); static PASSProcessModelElement(){ customCulture.NumberFormat.NumberDecimalSeparator = "."; }
  
  Angegeben von:
  
  getClassName in Schnittstelle IParseablePASSProcessModelElement
  
  Setzt außer Kraft:
  
  getClassName in Klasse ALPSSIDComponent
  
  Gibt zurück:
  
  The name of the current class
- getParsedInstance
  
  public IParseablePASSProcessModelElement getParsedInstance()
  
  Angegeben von:
  
  getParsedInstance in Schnittstelle IParseablePASSProcessModelElement
  
  Setzt außer Kraft:
  
  getParsedInstance in Klasse ALPSSIDComponent
- getExportTag
  
  protected String getExportTag()
  
  Setzt außer Kraft:
  
  getExportTag in Klasse ALPSSIDComponent
- setCorrespondents
  
  public void setCorrespondents(ISubject correspondentA, ISubject correspondentB, int removeCascadeDepth)
  
  Angegeben von:
  
  setCorrespondents in Schnittstelle ICommunicationChannel
- setCorrespondents
  
  public void setCorrespondents(ISubject correspondentA, ISubject correspondentB)
  
  Angegeben von:
  
  setCorrespondents in Schnittstelle ICommunicationChannel
- parseAttribute
  
  protected boolean parseAttribute(String predicate, String objectContent, String lang, String dataType, IParseablePASSProcessModelElement element)
  
  Beschreibung aus Klasse kopiert: PASSProcessModelElement
  
  Gets called while parsing a triple from a set of triples where this element is subject. The predicate and objectContent are derived directly from the triple, lang and dataType might be null (they will never both be NonNull at the same time) If the object specifies an uri to another element and the collection of all available elements contains this element, the element is passed as well
  
  Setzt außer Kraft:
  
  parseAttribute in Klasse PASSProcessModelElement
  
  Parameter:
  
  predicate - the predicate contained by the triple
  
  objectContent - the content of the object contained by the triple
  
  lang - the lang attribute of the object if one was specified
  
  dataType - the datatype attribute of the object if one was specified
  
  element - the element the objectContent points to (if it does and the element exists)
  
  Gibt zurück:
- setCorrespondentA
  
  public void setCorrespondentA(ISubject correspondentA, int removeCascadeDepth)
  
  Angegeben von:
  
  setCorrespondentA in Schnittstelle ICommunicationChannel
- setCorrespondentA
  
  public void setCorrespondentA(ISubject correspondentA)
  
  Angegeben von:
  
  setCorrespondentA in Schnittstelle ICommunicationChannel
- setCorrespondentB
  
  public void setCorrespondentB(ISubject correspondentB, int removeCascadeDepth)
  
  Angegeben von:
  
  setCorrespondentB in Schnittstelle ICommunicationChannel
- setCorrespondentB
  
  public void setCorrespondentB(ISubject correspondentB)
  
  Angegeben von:
  
  setCorrespondentB in Schnittstelle ICommunicationChannel
- getCorrespondentA
  
  public ISubject getCorrespondentA()
  
  Angegeben von:
  
  getCorrespondentA in Schnittstelle ICommunicationChannel
- getCorrespondentB
  
  public ISubject getCorrespondentB()
  
  Angegeben von:
  
  getCorrespondentB in Schnittstelle ICommunicationChannel
- getCorrespondents
  
  public org.apache.commons.lang3.tuple.Pair<ISubject,ISubject> getCorrespondents()
  
  Angegeben von:
  
  getCorrespondents in Schnittstelle ICommunicationChannel
- setIsUniDirectional
  
  public void setIsUniDirectional(boolean isUniDirectional)
  
  Beschreibung aus Schnittstelle kopiert: ICommunicationChannel
  
  Sets the direction of the channel. This might be either Uni- or BiDirectional. In case of a UniDirectional, the CorrespondentA should be assumed as the Sender, and Correspondent should be assumed as the Receiver.
  
  Angegeben von:
  
  setIsUniDirectional in Schnittstelle ICommunicationChannel
  
  Parameter:
  
  isUniDirectional - If true, this channel acts as UniDirectionalCommunicationChannel. If false, this channel acts as BiDirectionalCommunicationChannel.
- isUniDirectional
  
  public boolean isUniDirectional()
  
  Beschreibung aus Schnittstelle kopiert: ICommunicationChannel
  
  Returns whether this channel is a Bi- or UniDirectionalCommunicationChannel.
  
  Angegeben von:
  
  isUniDirectional in Schnittstelle ICommunicationChannel
  
  Gibt zurück:
  
  If true, the channel is UniDirectional, assuming the CorrespondentA as the Sender and CorrespondentB as Receiver. If false, the channel is BiDirectional
- get2DPageRatio
  
  public double get2DPageRatio()
  
  Beschreibung aus Schnittstelle kopiert: IHasSimple2DVisualizationLine
  
  The relative positions of the simple 2D Vizualiations are given in % of page hight and width No absolut values are given but a page ratio that defines whether it is a wide or tall format
  
  Angegeben von:
  
  get2DPageRatio in Schnittstelle IHasSimple2DVisualizationLine
  
  Gibt zurück:
- set2DPageRatio
  
  public void set2DPageRatio(double has2DPageRatio)
  
  Angegeben von:
  
  set2DPageRatio in Schnittstelle IHasSimple2DVisualizationLine
- getRelative2DBeginX
  
  public double getRelative2DBeginX()
  
  Angegeben von:
  
  getRelative2DBeginX in Schnittstelle IHasSimple2DVisualizationLine
- setRelative2DBeginX
  
  public void setRelative2DBeginX(double relative2DBeginX)
  
  Angegeben von:
  
  setRelative2DBeginX in Schnittstelle IHasSimple2DVisualizationLine
- getRelative2DBeginY
  
  public double getRelative2DBeginY()
  
  Angegeben von:
  
  getRelative2DBeginY in Schnittstelle IHasSimple2DVisualizationLine
- setRelative2DBeginY
  
  public void setRelative2DBeginY(double relative2DBeginY)
  
  Angegeben von:
  
  setRelative2DBeginY in Schnittstelle IHasSimple2DVisualizationLine
- getRelative2DEndX
  
  public double getRelative2DEndX()
  
  Angegeben von:
  
  getRelative2DEndX in Schnittstelle IHasSimple2DVisualizationLine
- setRelative2DEndX
  
  public void setRelative2DEndX(double relative2DEndX)
  
  Angegeben von:
  
  setRelative2DEndX in Schnittstelle IHasSimple2DVisualizationLine
- getRelative2DEndY
  
  public double getRelative2DEndY()
  
  Angegeben von:
  
  getRelative2DEndY in Schnittstelle IHasSimple2DVisualizationLine
- setRelative2DEndY
  
  public void setRelative2DEndY(double relative2DEndY)
  
  Angegeben von:
  
  setRelative2DEndY in Schnittstelle IHasSimple2DVisualizationLine
- getSimple2DPathPoints
  
  public List<ISimple2DVisualizationPathPoint> getSimple2DPathPoints()
  
  Angegeben von:
  
  getSimple2DPathPoints in Schnittstelle IHasSimple2DVisualizationLine
- addSimple2DPathPoint
  
  public void addSimple2DPathPoint(ISimple2DVisualizationPathPoint point)
  
  Angegeben von:
  
  addSimple2DPathPoint in Schnittstelle IHasSimple2DVisualizationLine

Klasse CommunicationChannel

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen alps.java.api.StandardPASS.PASSProcessModelElement

Feldübersicht

Von Klasse geerbte Felder alps.java.api.StandardPASS.PassProcessModelElements.InteractionDescribingComponent

Von Klasse geerbte Felder alps.java.api.StandardPASS.PASSProcessModelElement

Konstruktorübersicht

Methodenübersicht

Von Klasse geerbte Methoden alps.java.api.StandardPASS.PassProcessModelElements.InteractionDescribingComponent

Von Klasse geerbte Methoden alps.java.api.StandardPASS.PASSProcessModelElement

Von Klasse geerbte Methoden java.lang.Object

Von Schnittstelle geerbte Methoden alps.java.api.util.IContainableElement

Von Schnittstelle geerbte Methoden alps.java.api.StandardPASS.IPASSProcessModelElement

Von Schnittstelle geerbte Methoden alps.java.api.util.IValueChangedObserver

Von Schnittstelle geerbte Methoden alps.java.api.util.IValueChangedPublisher

Felddetails

className

Log

correspondentA

correspondentB

channelIsUniDirectional

oldIsUniDirectionalValue

has2DPageRatio

hasRelative2D_BeginX

hasRelative2D_BeginY

hasRelative2D_EndX

hasRelative2D_EndY

pathPoints

Konstruktordetails

CommunicationChannel

CommunicationChannel

CommunicationChannel

Methodendetails

getClassName

getParsedInstance

getExportTag

setCorrespondents

setCorrespondents

parseAttribute

setCorrespondentA

setCorrespondentA

setCorrespondentB

setCorrespondentB

getCorrespondentA

getCorrespondentB

getCorrespondents

setIsUniDirectional

isUniDirectional

get2DPageRatio

set2DPageRatio

getRelative2DBeginX

setRelative2DBeginX

getRelative2DBeginY

setRelative2DBeginY

getRelative2DEndX

setRelative2DEndX

getRelative2DEndY

setRelative2DEndY

getSimple2DPathPoints

addSimple2DPathPoint