|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.unihalle.informatik.Alida.operator.ALDPort
de.unihalle.informatik.Alida.operator.ALDOpNodePort
public abstract class ALDOpNodePort
Abstract class for ports residing within opNodes. Derived sub classes are input and output ports. Each port knows the opNode it resides in and its index in the corresponding array of input or output ports in the opNode. The typeName is used only for printing purposes.
Furthermore a ALDOpNodePort may record properties of the ALDData as it is passed into or out of the operator. Specifically, the properties of the data are retrieved an recorded for input data just before the operate method is invoced, and for output data when the operate method returns. Also the explanation from the operator is copied as we may not keep a reference to it to allow garbage collection. Last the canaonical class name of the ALDData bound to the port is recorded, again for input data just before the operate method is invoced, and for output data when the operate method returns.
Field Summary | |
---|---|
private java.lang.String |
classname
The canaonical class name of the ALDData bound to the port. |
private java.lang.String |
descriptorName
The descriptor name of this port within opNode |
private java.lang.String |
explanation
The explanation of this port. |
(package private) ALDOpNode |
opNode
The opNode this port belongs to |
private int |
portIndex
The index of this port within opNode |
private java.lang.Object |
properties
The properties retrieved from the data as it passed the port into or out of the operator. |
Fields inherited from class de.unihalle.informatik.Alida.operator.ALDPort |
---|
typeName |
Constructor Summary | |
---|---|
ALDOpNodePort(java.lang.String typeName,
ALDOpNode opNode,
int idx,
java.lang.String descriptorName)
Create a port for an opNode with given index within this opNode and type. |
Method Summary | |
---|---|
java.lang.String |
getClassname()
Return the canonical classname of the ALDData associated with this port |
java.lang.String |
getDescriptorName()
Return the descriptor name of the port within its opNode |
java.lang.String |
getExplanation()
Return the explanation of the port copied from the argument descriptor |
ALDOpNode |
getOpNode()
Return the opNode of this port |
int |
getPortIndex()
Return the index of the port within its opNode |
java.lang.Object |
getProperties()
Return the properties associated with this port which have been retrieved from the data as it passed the port. |
void |
print(java.lang.String indent)
Print information of this port onto System.out |
void |
setClassname(java.lang.String cn)
Set the canonical classname of the ALDData associated with this port |
void |
setExplanation(java.lang.String e)
Set the explanation of the port copied from the argument descriptor |
(package private) java.lang.Object |
setProperties(java.lang.Object properties)
Set the properties to be associated with this port. |
Methods inherited from class de.unihalle.informatik.Alida.operator.ALDPort |
---|
getOrigin, print, setOrigin |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private java.lang.String classname
private java.lang.String descriptorName
private java.lang.String explanation
ALDOpNode opNode
private int portIndex
private java.lang.Object properties
Constructor Detail |
---|
public ALDOpNodePort(java.lang.String typeName, ALDOpNode opNode, int idx, java.lang.String descriptorName)
typeName
- type of this port as a string, used only for printingopNode
- opNode this port resides inidx
- index of this port within the corresponding array of ports within opNodeMethod Detail |
---|
public java.lang.String getClassname()
public java.lang.String getDescriptorName()
public java.lang.String getExplanation()
public ALDOpNode getOpNode()
public int getPortIndex()
public java.lang.Object getProperties()
public void print(java.lang.String indent)
print
in class ALDPort
public void setClassname(java.lang.String cn)
cn
- canonical classname of the ALDData associated with this portpublic void setExplanation(java.lang.String e)
e
- explanation of the port within ints opNodejava.lang.Object setProperties(java.lang.Object properties)
properties
- to set for the port
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |