com.rapidminer.tools.documentation
Class XMLOperatorDocBundle

java.lang.Object
  java.util.ResourceBundle
      com.rapidminer.tools.documentation.OperatorDocBundle
          com.rapidminer.tools.documentation.XMLOperatorDocBundle

public class XMLOperatorDocBundle
extends OperatorDocBundle

A resource bundle that maps operator names to OperatorDocumentation instances. Instances of this class always return OperatorDocumentations from their ResourceBundle.getObject(String) methods. The XML structure of the documentation is as follows: For every operator there is a tag

  <operator>
    <synopsis>SYNOPSIS</synopsis>
    <help>LONG HELP TEXT</help>
    <example>
      <process>XML process string</process>
      <comment>COMMENT</comment>
    </example>
    <example>
       ...
    </example>
  </operator>
  

Author:

Simon Fischer

Nested Class Summary

Nested classes/interfaces inherited from class java.util.ResourceBundle

java.util.ResourceBundle.Control

Field Summary

Fields inherited from class com.rapidminer.tools.documentation.OperatorDocBundle

GROUP_PREFIX, OPERATOR_PREFIX

Fields inherited from class java.util.ResourceBundle

parent

Constructor Summary

XMLOperatorDocBundle(java.net.URL url, java.lang.String resourceName)
Constructs a new OperatorDocBundle

Method Summary

static OperatorDocBundle

load(java.lang.ClassLoader classLoader, java.lang.String resource) Loads the default "OperatorDoc.xml" file from the given resource base name.

Methods inherited from class com.rapidminer.tools.documentation.OperatorDocBundle

addGroupDoc, addOperatorDoc, check, getKeys, handleGetObject

Methods inherited from class java.util.ResourceBundle

clearCache, clearCache, containsKey, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getLocale, getObject, getString, getStringArray, handleKeySet, keySet, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLOperatorDocBundle

public XMLOperatorDocBundle(java.net.URL url,
                            java.lang.String resourceName)
                     throws java.io.IOException

Constructs a new OperatorDocBundle

Parameters:

url - The URL from which we are reading.

resourceName - The original resource name. This is the last part of the path of the URL and will be used to locate the source file, when this bundle is saved.

Throws:

java.io.IOException

Method Detail

load

public static OperatorDocBundle load(java.lang.ClassLoader classLoader,
                                     java.lang.String resource)

Loads the default "OperatorDoc.xml" file from the given resource base name.