Java OperatorDocumentation类代码示例

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
/**
 * Creates an operator description with the given fields.
 *
 * @deprecated This constructor cannot provide an internationalization mechanism since
 *             description is not taken from operator documentation bundle.
 */
@SuppressWarnings("unchecked")
@Deprecated
public OperatorDescription(final ClassLoader classLoader, final String key, final String name, final String className,
		final String shortDescription, final String longDescription, final String groupName, final String iconName,
		final String deprecationInfo, final Plugin provider) throws ClassNotFoundException {
	this.key = key;

	this.clazz = (Class<? extends Operator>) Class.forName(className, true, classLoader);
	this.documentation = new OperatorDocumentation(name);
	this.documentation.setSynopsis(shortDescription);
	this.documentation.setDocumentation(longDescription);
	this.documentation.setDeprecation(deprecationInfo);

	this.fullyQualifiedGroupKey = groupName;

	this.provider = provider;

	setIconName(iconName);
	updateIcons();
}
 

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
/**
 * Parses an operator in the RM 5.0 xml standard for operator definitions.
 * In contrast to earlier versions, the {@link OperatorDescription} does not
 * register themselves on the OperatorTree. This is now handled centralized by the {@link OperatorService}.
 * 
 * @param bundle
 */
@SuppressWarnings("unchecked")
public OperatorDescription(String fullyQualifiedGroupKey, Element element, ClassLoader classLoader, Plugin provider, OperatorDocBundle bundle) throws ClassNotFoundException, XMLException {
    this.provider = provider;
    this.fullyQualifiedGroupKey = fullyQualifiedGroupKey;

    key = XMLTools.getTagContents(element, "key", true);
    setIconName(XMLTools.getTagContents(element, "icon"));

    Class<?> generatedClass = Class.forName(XMLTools.getTagContents(element, "class", true).trim(), true, classLoader);
    this.clazz = (Class<? extends Operator>) generatedClass;

    this.documentation = (OperatorDocumentation) bundle.getObject("operator." + key);
    if (documentation.getName().equals("")) {
        documentation.setName(key);
        documentation.setDocumentation("Operator's description is missing in referenced OperatorDoc.");
    }

    NodeList children = element.getChildNodes();
    for (int i = 0; i < children.getLength(); i++) {
        Node child = children.item(i);
        if (child instanceof Element && ((Element) child).getTagName().equals("replaces")) {
            setIsReplacementFor(((Element) child).getTextContent());
        }
    }
}
 

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
public String getLongDescriptionHTML() {
	OperatorDocumentation operatorDocumentation = getOperatorDocumentation();
	if (operatorDocumentation.getDocumentation() != null) {
		return operatorDocumentation.getDocumentation();
	}
	if (operatorDocumentation.getSynopsis() != null) {
		return operatorDocumentation.getSynopsis();
	}
	return "";
}
 

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
/**
 * Adds parent folder name of each operator to the operator tags.
 */
private static void addParentFolderOperatorTags() {
	for (String operatorKey : getOperatorKeys()) {
		OperatorDescription operatorDescription = getOperatorDescription(operatorKey);
		if (operatorDescription == null) {
			continue;
		}
		if (ProcessRootOperator.class.equals(operatorDescription.getOperatorClass())) {
			// no tags for the root process
			continue;
		}
		GroupTree subTree = groupTreeRoot.findGroup(operatorDescription.getGroup());
		if (subTree == null) {
			continue;
		}
		String groupName = subTree.getName();
		if (groupName != null && !groupName.trim().isEmpty()) {
			if (!operatorDescription.getTags().contains(groupName.trim())) {
				OperatorDocumentation operatorDocumentation = operatorDescription.getOperatorDocumentation();
				ArrayList<String> updatedTags = new ArrayList<>(operatorDocumentation.getTags().size() + 1);
				updatedTags.addAll(operatorDocumentation.getTags());
				updatedTags.add(groupName.trim());
				operatorDocumentation.setTags(updatedTags);
			}
		}
	}
}
 

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
public String getLongDescriptionHTML() {
    OperatorDocumentation operatorDocumentation = getOperatorDocumentation();
    if (operatorDocumentation.getDocumentation() != null)
        return operatorDocumentation.getDocumentation();
    if (operatorDocumentation.getSynopsis() != null)
        return operatorDocumentation.getSynopsis();
    return "";
}
 

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
public OperatorDocumentation getOperatorDocumentation() {
	return documentation;
}
 

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
public OperatorDocumentation getOperatorDocumentation() {
    return documentation;
}
 

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
/**
 * This method has to return a {@link OperatorDocumentation} for the given key. The result must
 * be not null! If no documentation exists, use a default one, with just the key as name.
 */
public OperatorDocumentation getOperatorDocumentation(String operatorKey);
 

import com.rapidminer.tools.documentation.OperatorDocumentation; //导入依赖的package包/类
/**
 * This method has to return a {@link OperatorDocumentation} for the given key.
 * The result must be not null! If no documentation exists, use a default one,
 * with just the key as name.
 */
public OperatorDocumentation getOperatorDocumentation(String operatorKey);