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

Class DocumentReferences

java.lang.Object

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

public class DocumentReferences
extends Object

Build a reference documentation for all available parameters.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private static Comparator<Object>	COMPARATOR Comparator for sorting the list of classes for each reference.
private static String	CSSFILE
private static Logging	LOG Logger
private static String	MODIFICATION_WARNING

Constructor Summary

Constructors

Constructor and Description
DocumentReferences()

Method Summary

Methods

Modifier and Type	Method and Description
private static void	addReference(Object cls, Reference ref, List<Pair<Reference,TreeSet<Object>>> refs, Map<Reference,TreeSet<Object>> map)
private static Document	documentReferences(List<Pair<Reference,TreeSet<Object>>> refs)
private static void	documentReferencesWiki(List<Pair<Reference,TreeSet<Object>>> refs, PrintStream refstreamW)
static ArrayList<Class<?>>	findAllClassesWithReferences() Find all classes that have the reference annotation
private static void	inspectClass(Class<?> cls, List<Pair<Reference,TreeSet<Object>>> refs, Map<Reference,TreeSet<Object>> map)
private static void	inspectPackage(Package p, List<Pair<Reference,TreeSet<Object>>> refs, Map<Reference,TreeSet<Object>> map)
private static String	linkForClassName(String name)
private static String	linkForPackageName(String name)
static void	main(String[] args)
private static List<Pair<Reference,TreeSet<Object>>>	sortedReferences()

Methods inherited from class java.lang.Object

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

Field Detail

CSSFILE

private static final String CSSFILE

See Also:

Constant Field Values

MODIFICATION_WARNING

private static final String MODIFICATION_WARNING

See Also:

Constant Field Values

LOG

private static final Logging LOG

Logger

COMPARATOR

private static final Comparator<Object> COMPARATOR

Comparator for sorting the list of classes for each reference.

Constructor Detail

DocumentReferences

public DocumentReferences()

Method Detail

main

public static void main(String[] args)

Parameters:

args - Command line arguments

documentReferences

private static Document documentReferences(List<Pair<Reference,TreeSet<Object>>> refs)

documentReferencesWiki

private static void documentReferencesWiki(List<Pair<Reference,TreeSet<Object>>> refs,
                          PrintStream refstreamW)

sortedReferences

private static List<Pair<Reference,TreeSet<Object>>> sortedReferences()

inspectClass

private static void inspectClass(Class<?> cls,
                List<Pair<Reference,TreeSet<Object>>> refs,
                Map<Reference,TreeSet<Object>> map)

addReference

private static void addReference(Object cls,
                Reference ref,
                List<Pair<Reference,TreeSet<Object>>> refs,
                Map<Reference,TreeSet<Object>> map)

inspectPackage

private static void inspectPackage(Package p,
                  List<Pair<Reference,TreeSet<Object>>> refs,
                  Map<Reference,TreeSet<Object>> map)

linkForClassName

private static String linkForClassName(String name)

linkForPackageName

private static String linkForPackageName(String name)

findAllClassesWithReferences

public static ArrayList<Class<?>> findAllClassesWithReferences()

Find all classes that have the reference annotation

Returns:

All classes with the reference annotation.