org.qedeq.kernel.bo.module
Interface Reference

All Known Implementing Classes:
DefaultReference

public interface Reference

Reference to another QEDEQ module, a node, a part of a node formula, a formal proof line.

Author:
Michael Meyling

Method Summary
 KernelQedeqBo getExternalQedeq()
          Get external QEDEQ module the reference points to.
 java.lang.String getExternalQedeqLabel()
          Get label for QEDEQ module the reference points to.
 KernelNodeBo getNode()
          Node the reference points to.
 java.lang.String getNodeLabel()
          Label of the node the reference points to.
 java.lang.String getProofLineLabel()
          Proof line label of a node the reference points to.
 java.lang.String getSubLabel()
          Sub node label the reference points to.
 boolean isExternal()
          Does the the reference point to another QEDEQ module?
 boolean isExternalModuleReference()
          Does the the reference point to another QEDEQ module but not to a node?
 boolean isNodeLocalReference()
          Does the the reference point to the same node?
 boolean isNodeReference()
          Does the the reference point to a node? It might also be a sub reference to a node like a part of a proposition or a formal proof line.
 boolean isProofLineReference()
          Does the the reference point to a proof line of a node? If this is true it can not have a node sub reference.
 boolean isSubReference()
          Does the the reference point to a sub reference of a node? This is a part of a node formula.
 

Method Detail

isExternal

boolean isExternal()
Does the the reference point to another QEDEQ module?

Returns:
The reference goes to another module.

isExternalModuleReference

boolean isExternalModuleReference()
Does the the reference point to another QEDEQ module but not to a node?

Returns:
The reference goes directly to to another module.

getExternalQedeqLabel

java.lang.String getExternalQedeqLabel()
Get label for QEDEQ module the reference points to.

Returns:
QEDEQ module label.

getExternalQedeq

KernelQedeqBo getExternalQedeq()
Get external QEDEQ module the reference points to.

Returns:
QEDEQ module.

isNodeReference

boolean isNodeReference()
Does the the reference point to a node? It might also be a sub reference to a node like a part of a proposition or a formal proof line.

Returns:
The reference goes to a node or to a label within a node.

getNodeLabel

java.lang.String getNodeLabel()
Label of the node the reference points to.

Returns:
Node label the reference points to.

getNode

KernelNodeBo getNode()
Node the reference points to. Might be in an external QEDEQ module. The reference might also have a sub reference or proof line reference.

Returns:
Node the reference points to.

isNodeLocalReference

boolean isNodeLocalReference()
Does the the reference point to the same node?

Returns:
The reference is in the same node as the label.

isSubReference

boolean isSubReference()
Does the the reference point to a sub reference of a node? This is a part of a node formula. If this is true it can not have a proof line reference.

Returns:
The reference goes to a part of a node formula.

getSubLabel

java.lang.String getSubLabel()
Sub node label the reference points to.

Returns:
Sub node label the reference points to.

isProofLineReference

boolean isProofLineReference()
Does the the reference point to a proof line of a node? If this is true it can not have a node sub reference.

Returns:
The reference goes to a proof line.

getProofLineLabel

java.lang.String getProofLineLabel()
Proof line label of a node the reference points to.

Returns:
Proof line label the reference points to.


Copyright © 2014. All Rights Reserved.