de.lmu.ifi.dbs.elki.application.internal

Class DocumentParameters

java.lang.Object

de.lmu.ifi.dbs.elki.application.internal.DocumentParameters

public class DocumentParameters
extends Object

Class to generate HTML parameter descriptions for all classes implementing the Parameterizable interface. Used in documentation generation only.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DocumentParameters.SortByOption Sort parameters by their option
private static class	DocumentParameters.WikiStream Write to a Wiki format.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	CSSFILE
private static boolean	FULL_WIKI_OUTPUT Enable the full wiki output.
private static String	HEADER_CLASS_RESTRICTION
private static String	HEADER_CLASS_RESTRICTION_EXTENDING
private static String	HEADER_CLASS_RESTRICTION_IMPLEMENTING
private static String	HEADER_DEFAULT_VALUE
private static String	HEADER_KNOWN_IMPLEMENTATIONS
private static String	HEADER_PARAMETER_FOR
private static Logging	LOG
private static String	MODIFICATION_WARNING
private static String	NO_CLASS_RESTRICTION
private static String	NO_DEFAULT_VALUE

Constructor Summary

Constructors

Constructor and Description
DocumentParameters()

Method Summary

Methods

Modifier and Type	Method and Description
private static void	appendClassRestriction(Document htmldoc, Class<?> restriction, Element elemdd)
private static void	appendClassRestrictionWiki(DocumentParameters.WikiStream out, Class<?> restriction)
private static void	appendDefaultClassLink(Document htmldoc, Parameter<?> opt, Element p)
private static void	appendDefaultValueIfSet(Document htmldoc, Parameter<?> par, Element optdd) Append string containing the default value.
private static void	appendDefaultValueWiki(DocumentParameters.WikiStream out, Parameter<?> par)
private static void	appendKnownImplementationsIfNonempty(Document htmldoc, ClassParameter<?> opt, Element elemdd)
private static void	appendKnownImplementationsWiki(DocumentParameters.WikiStream out, ClassParameter<?> opt)
private static int	appendMultilineTextWiki(DocumentParameters.WikiStream out, String text)
private static void	appendNoClassRestriction(Document htmldoc, Element elemdd)
private static void	appendNoClassRestrictionWiki(DocumentParameters.WikiStream out)
private static void	appendNoDefaultValue(Document htmldoc, Element optdd) Append string that there is not default value.
private static void	appendNoDefaultValueWiki(DocumentParameters.WikiStream out)
private static void	buildParameterIndex(Map<Class<?>,List<Parameter<?>>> byclass, Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt)
protected static Constructor<?>	getConstructor(Class<?> cls)
private static String	linkForClassName(String name) Return a link for the class name
static void	main(String[] args)
private static Document	makeByClassOverviewHTML(Map<Class<?>,List<Parameter<?>>> byclass)
private static void	makeByClassOverviewWiki(Map<Class<?>,List<Parameter<?>>> byclass, DocumentParameters.WikiStream out)
private static Document	makeByOptOverviewHTML(Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt)
private static void	makeByOptOverviewWiki(Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt, DocumentParameters.WikiStream out)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logging LOG

HEADER_PARAMETER_FOR

private static final String HEADER_PARAMETER_FOR

See Also:

Constant Field Values

HEADER_DEFAULT_VALUE

private static final String HEADER_DEFAULT_VALUE

See Also:

Constant Field Values

NO_DEFAULT_VALUE

private static final String NO_DEFAULT_VALUE

See Also:

Constant Field Values

HEADER_CLASS_RESTRICTION

private static final String HEADER_CLASS_RESTRICTION

See Also:

Constant Field Values

HEADER_CLASS_RESTRICTION_IMPLEMENTING

private static final String HEADER_CLASS_RESTRICTION_IMPLEMENTING

See Also:

Constant Field Values

HEADER_CLASS_RESTRICTION_EXTENDING

private static final String HEADER_CLASS_RESTRICTION_EXTENDING

See Also:

Constant Field Values

NO_CLASS_RESTRICTION

private static final String NO_CLASS_RESTRICTION

See Also:

Constant Field Values

CSSFILE

private static final String CSSFILE

See Also:

Constant Field Values

MODIFICATION_WARNING

private static final String MODIFICATION_WARNING

See Also:

Constant Field Values

HEADER_KNOWN_IMPLEMENTATIONS

private static final String HEADER_KNOWN_IMPLEMENTATIONS

See Also:

Constant Field Values

FULL_WIKI_OUTPUT

private static final boolean FULL_WIKI_OUTPUT

Enable the full wiki output. Currently not sensible, as there is a size restriction on wiki pages, so we would need to split this somehow!

See Also:

Constant Field Values

Constructor Detail

DocumentParameters

public DocumentParameters()

Method Detail

main

public static void main(String[] args)

Parameters:

args - Command line arguments

buildParameterIndex

private static void buildParameterIndex(Map<Class<?>,List<Parameter<?>>> byclass,
                       Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt)

getConstructor

protected static Constructor<?> getConstructor(Class<?> cls)

makeByClassOverviewHTML

private static Document makeByClassOverviewHTML(Map<Class<?>,List<Parameter<?>>> byclass)

makeByClassOverviewWiki

private static void makeByClassOverviewWiki(Map<Class<?>,List<Parameter<?>>> byclass,
                           DocumentParameters.WikiStream out)

appendMultilineTextWiki

private static int appendMultilineTextWiki(DocumentParameters.WikiStream out,
                          String text)

makeByOptOverviewHTML

private static Document makeByOptOverviewHTML(Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt)

makeByOptOverviewWiki

private static void makeByOptOverviewWiki(Map<OptionID,List<Pair<Parameter<?>,Class<?>>>> byopt,
                         DocumentParameters.WikiStream out)

appendDefaultClassLink

private static void appendDefaultClassLink(Document htmldoc,
                          Parameter<?> opt,
                          Element p)

appendClassRestriction

private static void appendClassRestriction(Document htmldoc,
                          Class<?> restriction,
                          Element elemdd)

appendNoClassRestriction

private static void appendNoClassRestriction(Document htmldoc,
                            Element elemdd)

appendClassRestrictionWiki

private static void appendClassRestrictionWiki(DocumentParameters.WikiStream out,
                              Class<?> restriction)

appendNoClassRestrictionWiki

private static void appendNoClassRestrictionWiki(DocumentParameters.WikiStream out)

appendKnownImplementationsIfNonempty

private static void appendKnownImplementationsIfNonempty(Document htmldoc,
                                        ClassParameter<?> opt,
                                        Element elemdd)

appendKnownImplementationsWiki

private static void appendKnownImplementationsWiki(DocumentParameters.WikiStream out,
                                  ClassParameter<?> opt)

appendDefaultValueIfSet

private static void appendDefaultValueIfSet(Document htmldoc,
                           Parameter<?> par,
                           Element optdd)

Append string containing the default value.

Parameters:

htmldoc - Document

par - Parameter

optdd - HTML Element

appendNoDefaultValue

private static void appendNoDefaultValue(Document htmldoc,
                        Element optdd)

Append string that there is not default value.

Parameters:

htmldoc - Document

optdd - HTML Element

appendDefaultValueWiki

private static void appendDefaultValueWiki(DocumentParameters.WikiStream out,
                          Parameter<?> par)

appendNoDefaultValueWiki

private static void appendNoDefaultValueWiki(DocumentParameters.WikiStream out)

linkForClassName

private static String linkForClassName(String name)

Return a link for the class name

Parameters:

name - Class name

Returns:

(relative) link destination