com.rapidminer.tools.documentation
Class OperatorDocumentation

java.lang.Object
  com.rapidminer.tools.documentation.OperatorDocumentation

public class OperatorDocumentation
extends java.lang.Object

The operator documentation, currently consisting of a short synopsis, a long help text plus examples. None of the getters returns null. If no long description is given, the synopsis will be returned. Setting properties of instances of this class will, as a side effect, also modify the original DOM element used to create this instance, so the DOM is always in sync with the data.

Author:

Simon Fischer

Constructor Summary

OperatorDocumentation(java.lang.String name)

Method Summary

void	addExample(Process process, java.lang.String comment)
OperatorDocBundle	getBundle()
java.lang.String	getDeprecation()
java.lang.String	getDocumentation()
java.util.List<ExampleProcess>	getExamples()
java.lang.String	getName()
java.lang.String	getShortName()
java.lang.String	getSynopsis()
void	removeExample(int index)
void	setDeprecation(java.lang.String deprecation)
void	setDocumentation(java.lang.String text)
void	setName(java.lang.String name)
void	setShortName(java.lang.String shortName)
void	setSynopsis(java.lang.String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorDocumentation

public OperatorDocumentation(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getShortName

public java.lang.String getShortName()

setShortName

public void setShortName(java.lang.String shortName)

getSynopsis

public java.lang.String getSynopsis()

getDocumentation

public java.lang.String getDocumentation()

setDocumentation

public void setDocumentation(java.lang.String text)

setSynopsis

public void setSynopsis(java.lang.String text)

getDeprecation

public java.lang.String getDeprecation()

setDeprecation

public void setDeprecation(java.lang.String deprecation)

addExample

public void addExample(Process process,
                       java.lang.String comment)

getExamples

public java.util.List<ExampleProcess> getExamples()

removeExample

public void removeExample(int index)

getBundle

public OperatorDocBundle getBundle()