Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> embl >> ebi >> escience >> [ scufl overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.embl.ebi.escience.scufl
Class Port  

java.lang.Object
  org.embl.ebi.escience.scufl.Port

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InputPort, OutputPort

---

public abstract class Port

extends java.lang.Object

implements java.io.Serializable

An abstract superclass of all processor ports

---

Field Summary
private  java.util.List	aliases
private  java.lang.String	description
private  boolean	isExternal
private  java.lang.String	name
private  Processor	processor
private  java.lang.String	semanticType
private  java.lang.String	syntacticType

 

Constructor Summary

Port(Processor processor, java.lang.String name)           Create a new port (obviously you can't actually construct this because it's abstract.

 

Method Summary
void	addAlias(java.lang.String name)           Add a name to the list of aliases used to reference this port.
(package private)  void	fireModelEvent(ScuflModelEvent event)           Handle model events
java.lang.String	getDescription()           Get the description for this port
java.lang.String	getName()           Get the name for this port.
Processor	getProcessor()           Get the processor that this port belongs to.
java.lang.String	getSemanticType()           Get the semantic type of the port, not implemented in this version of the spec or software.
java.lang.String	getSyntacticType()           Get the syntactic type of the port
boolean	isAlias(java.lang.String name)           Checks to see if supplied name is an alias for the port
boolean	isExternal()           Deprecated.
boolean	isSink()           Is this port a workflow sink?
boolean	isSource()           Is this port a workflow source?
void	setDescription(java.lang.String theDescription)           Set the free text description of the port
void	setExternal(boolean external_value)           Deprecated.
(package private)  void	setSemanticType(java.lang.String new_type)           Set the semantic type of the port, only visible within this package, currently unused by this version of the software.
(package private)  void	setSyntacticType(java.lang.String new_type)           Set the syntactic type of the port, only visible within this package by default.
java.lang.String	toString()           Return the name as the toString() implementation

 

Methods inherited from class java.lang.Object

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

 

Field Detail

name

private java.lang.String name

---

processor

private Processor processor

---

isExternal

private boolean isExternal

---

syntacticType

private java.lang.String syntacticType

---

semanticType

private java.lang.String semanticType

---

aliases

private java.util.List aliases

---

description

private java.lang.String description

Constructor Detail

Port

public Port(Processor processor,
            java.lang.String name)
     throws DuplicatePortNameException,
            PortCreationException

Create a new port (obviously you can't actually construct this because it's abstract. Names must match [a-zA-Z_0-9]. Lies lies lies, I removed that bit because it was breaking EMBOSS. tmo

Method Detail

setDescription

public void setDescription(java.lang.String theDescription)

Set the free text description of the port

---

getDescription

public java.lang.String getDescription()

Get the description for this port

---

setSyntacticType

void setSyntacticType(java.lang.String new_type)

Set the syntactic type of the port, only visible within this package by default.

---

getSyntacticType

public java.lang.String getSyntacticType()

Get the syntactic type of the port

---

setSemanticType

void setSemanticType(java.lang.String new_type)

Set the semantic type of the port, only visible within this package, currently unused by this version of the software.

---

getSemanticType

public java.lang.String getSemanticType()

Get the semantic type of the port, not implemented in this version of the spec or software.

---

setExternal

public void setExternal(boolean external_value)

Deprecated.  

Set the visibility of this port outside the scope of the workflow

---

isExternal

public boolean isExternal()

Deprecated.  

Is this port visible outside the workflow?

---

isSource

public boolean isSource()

Is this port a workflow source?

---

isSink

public boolean isSink()

Is this port a workflow sink?

---

getProcessor

public Processor getProcessor()

Get the processor that this port belongs to.

---

getName

public java.lang.String getName()

Get the name for this port. There is no set method, ports are named at creation time and the names are immutable from that point onwards.

---

toString

public java.lang.String toString()

Return the name as the toString() implementation

---

addAlias

public void addAlias(java.lang.String name)

Add a name to the list of aliases used to reference this port.

---

isAlias

public boolean isAlias(java.lang.String name)

Checks to see if supplied name is an alias for the port

---

fireModelEvent

void fireModelEvent(ScuflModelEvent event)

Handle model events

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> embl >> ebi >> escience >> [ scufl overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---