org.qedeq.kernel.bo.service.unicode
Class Qedeq2UnicodeVisitor

java.lang.Object
  extended by org.qedeq.kernel.se.visitor.AbstractModuleVisitor
      extended by org.qedeq.kernel.bo.service.basis.ControlVisitor
          extended by org.qedeq.kernel.bo.service.unicode.Qedeq2UnicodeVisitor
All Implemented Interfaces:
ReferenceFinder, ListVisitor, QedeqVisitor

public class Qedeq2UnicodeVisitor
extends ControlVisitor
implements ReferenceFinder

Transfer a QEDEQ module into unicode text.

This is just a quick written generator. This class just generates some text output to be able to get a visual impression of a QEDEQ module.

Author:
Michael Meyling

Constructor Summary
Qedeq2UnicodeVisitor(ModuleService plugin, KernelQedeqBo prop, boolean info, int maximumColumn, boolean addWarnings, boolean brief)
          Constructor.
 
Method Summary
 void addWarning(int code, java.lang.String msg)
          Add warning.
 void addWarning(int code, java.lang.String msg, SourcePosition startDelta, SourcePosition endDelta)
          Add warning.
 void generateUtf8(InternalServiceJob process, AbstractOutput printer, java.lang.String language, java.lang.String level)
          Gives a UTF-8 representation of given QEDEQ module as InputStream.
 java.lang.String getReferenceLink(java.lang.String reference, SourcePosition start, SourcePosition end)
          Return string for reference link.
protected  java.lang.String getUtf8(Element element)
          Get Utf8 element presentation.
protected  java.lang.String[] getUtf8(Element element, int max)
          Get Utf8 element presentation.
protected  void init()
          Reset counters and other variables.
 void setParameters(AbstractOutput printer, java.lang.String language)
          Set parameters.
 void visitEnter(Add r)
          Visit certain element.
 void visitEnter(Axiom axiom)
          Visit certain element.
 void visitEnter(ChangedRule rule)
          Visit certain element.
 void visitEnter(ChangedRuleList list)
          Visit certain element.
 void visitEnter(Chapter chapter)
          Visit certain element.
 void visitEnter(Conclusion conclusion)
          Visit certain element.
 void visitEnter(ConditionalProof r)
          Visit conditional proof line.
 void visitEnter(Existential r)
          Visit certain element.
 void visitEnter(FormalProof proof)
          Visit certain element.
 void visitEnter(FormalProofLine line)
          Visit formal proof line (but not an conditional proof line).
 void visitEnter(FunctionDefinition definition)
          Visit certain element.
 void visitEnter(Header header)
          Visit certain element.
 void visitEnter(Hypothesis hypothesis)
          Visit certain element.
 void visitEnter(ImportList imports)
          Visit certain element.
 void visitEnter(InitialFunctionDefinition definition)
          Visit certain element.
 void visitEnter(InitialPredicateDefinition definition)
          Visit certain element.
 void visitEnter(LinkList linkList)
          Visit certain element.
 void visitEnter(LiteratureItem item)
          Visit certain element.
 void visitEnter(LiteratureItemList list)
          Visit certain element.
 void visitEnter(ModusPonens r)
          Visit certain element.
 void visitEnter(Node node)
          Visit certain element.
 void visitEnter(PredicateDefinition definition)
          Visit certain element.
 void visitEnter(Proof proof)
          Visit certain element.
 void visitEnter(Proposition proposition)
          Visit certain element.
 void visitEnter(Qedeq qedeq)
          Visit certain element.
 void visitEnter(Rename r)
          Visit certain element.
 void visitEnter(Rule rule)
          Visit certain element.
 void visitEnter(Section section)
          Visit certain element.
 void visitEnter(Subsection subsection)
          Visit certain element.
 void visitEnter(SubstFree r)
          Visit certain element.
 void visitEnter(SubstFunc r)
          Visit certain element.
 void visitEnter(SubstPred r)
          Visit certain element.
 void visitEnter(Universal r)
          Visit certain element.
 void visitLeave(Chapter chapter)
          Visit certain element.
 void visitLeave(Conclusion conclusion)
          Visit certain element.
 void visitLeave(ConditionalProof proof)
          Visit certain element.
 void visitLeave(FormalProof proof)
          Visit certain element.
 void visitLeave(FormalProofLine line)
          Visit certain element.
 void visitLeave(Header header)
          Visit certain element.
 void visitLeave(Hypothesis hypothesis)
          Visit certain element.
 void visitLeave(LiteratureItemList list)
          Visit certain element.
 void visitLeave(Node node)
          Visit certain element.
 void visitLeave(Proof proof)
          Visit certain element.
 void visitLeave(Qedeq qedeq)
          Visit certain element.
 void visitLeave(Section section)
          Visit certain element.
 
Methods inherited from class org.qedeq.kernel.bo.service.basis.ControlVisitor
addError, addError, addWarning, getBlocked, getCurrentContext, getCurrentNumbers, getErrorList, getInternalServiceCall, getInterrupted, getKernelQedeqBo, getLocalRuleKey, getLocationDescription, getNodeBo, getNodeDisplay, getReference, getService, getServices, getTraverser, getVisitPercentage, getWarningList, hasErrors, hasNoErrors, setBlocked, setLocationWithinModule, traverse
 
Methods inherited from class org.qedeq.kernel.se.visitor.AbstractModuleVisitor
visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitEnter, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave, visitLeave
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Qedeq2UnicodeVisitor

public Qedeq2UnicodeVisitor(ModuleService plugin,
                            KernelQedeqBo prop,
                            boolean info,
                            int maximumColumn,
                            boolean addWarnings,
                            boolean brief)
Constructor.

Parameters:
plugin - This plugin we work for.
prop - QEDEQ BO object.
info - Write reference info?
maximumColumn - Maximum column before automatic break. 0 means no automatic break.
addWarnings - Should warning messages be generated if LaTeX problems occur?
brief - Should only names and formulas be be printed?
Method Detail

generateUtf8

public void generateUtf8(InternalServiceJob process,
                         AbstractOutput printer,
                         java.lang.String language,
                         java.lang.String level)
                  throws SourceFileExceptionList,
                         java.io.IOException
Gives a UTF-8 representation of given QEDEQ module as InputStream.

Parameters:
process - We run in this process.
printer - Print herein.
language - Filter text to get and produce text in this language only.
level - Filter for this detail level. LATER 20100205 m31: not yet supported yet.
Throws:
SourceFileExceptionList - Major problem occurred.
java.io.IOException - File IO failed.

setParameters

public void setParameters(AbstractOutput printer,
                          java.lang.String language)
Set parameters.

Parameters:
printer - Print herein.
language - Choose this language.

init

protected void init()
Reset counters and other variables. Should be executed before #traverse().


visitEnter

public final void visitEnter(Qedeq qedeq)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
qedeq - Begin visit of this element.

visitLeave

public final void visitLeave(Qedeq qedeq)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
qedeq - End visit of this element.

visitEnter

public void visitEnter(Header header)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
header - Begin visit of this element.

visitEnter

public void visitEnter(ImportList imports)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
imports - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(Chapter chapter)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
chapter - Begin visit of this element.

visitLeave

public void visitLeave(Header header)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
header - End visit of this element.

visitLeave

public void visitLeave(Chapter chapter)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
chapter - End visit of this element.

visitEnter

public void visitEnter(Section section)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
section - Begin visit of this element.

visitLeave

public void visitLeave(Section section)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
section - End visit of this element.

visitEnter

public void visitEnter(Subsection subsection)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
subsection - Begin visit of this element.

visitEnter

public void visitEnter(Node node)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
node - Begin visit of this element.

visitLeave

public void visitLeave(Node node)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
node - End visit of this element.

visitEnter

public void visitEnter(Axiom axiom)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
axiom - Begin visit of this element.

visitEnter

public void visitEnter(Proposition proposition)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
proposition - Begin visit of this element.

visitEnter

public void visitEnter(Proof proof)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
proof - Begin visit of this element.

visitLeave

public void visitLeave(Proof proof)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
proof - End visit of this element.

visitEnter

public void visitEnter(FormalProof proof)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
proof - Begin visit of this element.

visitLeave

public void visitLeave(FormalProof proof)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
proof - End visit of this element.

visitEnter

public void visitEnter(FormalProofLine line)
Description copied from interface: QedeqVisitor
Visit formal proof line (but not an conditional proof line).

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
line - Begin visit of this element.

visitLeave

public void visitLeave(FormalProofLine line)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
line - End visit of this element.

visitEnter

public void visitEnter(ConditionalProof r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit conditional proof line.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitLeave

public void visitLeave(ConditionalProof proof)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
proof - End visit of this element.

visitEnter

public void visitEnter(Hypothesis hypothesis)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
hypothesis - Begin visit of this element.

visitLeave

public void visitLeave(Hypothesis hypothesis)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
hypothesis - End visit of this element.

visitEnter

public void visitEnter(Conclusion conclusion)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
conclusion - Begin visit of this element.

visitLeave

public void visitLeave(Conclusion conclusion)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
conclusion - End visit of this element.

visitEnter

public void visitEnter(ModusPonens r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(Add r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(Rename r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(SubstFree r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(SubstFunc r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(SubstPred r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(Existential r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(Universal r)
                throws ModuleDataException
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
r - Begin visit of this element.
Throws:
ModuleDataException - Major problem occurred.

visitEnter

public void visitEnter(InitialPredicateDefinition definition)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
definition - Begin visit of this element.

visitEnter

public void visitEnter(PredicateDefinition definition)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
definition - Begin visit of this element.

visitEnter

public void visitEnter(InitialFunctionDefinition definition)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
definition - Begin visit of this element.

visitEnter

public void visitEnter(FunctionDefinition definition)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
definition - Begin visit of this element.

visitEnter

public void visitEnter(Rule rule)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
rule - Begin visit of this element.

visitEnter

public void visitEnter(LinkList linkList)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
linkList - Begin visit of this element.

visitEnter

public void visitEnter(ChangedRuleList list)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
list - Begin visit of this element.

visitEnter

public void visitEnter(ChangedRule rule)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
rule - Begin visit of this element.

visitEnter

public void visitEnter(LiteratureItemList list)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
list - Begin visit of this element.

visitLeave

public void visitLeave(LiteratureItemList list)
Description copied from interface: QedeqVisitor
Visit certain element. End of visit.

Specified by:
visitLeave in interface QedeqVisitor
Overrides:
visitLeave in class AbstractModuleVisitor
Parameters:
list - End visit of this element.

visitEnter

public void visitEnter(LiteratureItem item)
Description copied from interface: QedeqVisitor
Visit certain element. Begin of visit.

Specified by:
visitEnter in interface QedeqVisitor
Overrides:
visitEnter in class AbstractModuleVisitor
Parameters:
item - Begin visit of this element.

addWarning

public void addWarning(int code,
                       java.lang.String msg,
                       SourcePosition startDelta,
                       SourcePosition endDelta)
Add warning.

Specified by:
addWarning in interface ReferenceFinder
Parameters:
code - Warning code.
msg - Warning message.
startDelta - Skip position (relative to location start). Could be null.
endDelta - Mark until this column (relative to location start). Could be be null

addWarning

public void addWarning(int code,
                       java.lang.String msg)
Add warning.

Parameters:
code - Warning code.
msg - Warning message.

getUtf8

protected java.lang.String[] getUtf8(Element element,
                                     int max)
Get Utf8 element presentation.

Parameters:
element - Get presentation of this element.
max - Maximum column.
Returns:
UTF-8 form of element.

getUtf8

protected java.lang.String getUtf8(Element element)
Get Utf8 element presentation.

Parameters:
element - Get presentation of this element.
Returns:
UTF-8 form of element.

getReferenceLink

public java.lang.String getReferenceLink(java.lang.String reference,
                                         SourcePosition start,
                                         SourcePosition end)
Description copied from interface: ReferenceFinder
Return string for reference link.

Specified by:
getReferenceLink in interface ReferenceFinder
Parameters:
reference - Link to this.
start - Absolute source position start of reference.
end - Absolute source position end of reference.
Returns:
Return reference as string.


Copyright © 2014. All Rights Reserved.