org.python.indexer

Class Outliner

java.lang.Object

org.python.indexer.Outliner

public class Outliner
extends java.lang.Object

Generates a file outline from the index: a structure representing the variable and attribute definitions in a file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Outliner.Branch An outline entry with children.
static class	Outliner.Entry
static class	Outliner.Leaf An entry with no children.

Constructor Summary

Constructors

Constructor and Description
Outliner()

Method Summary

Modifier and Type	Method and Description
java.util.List<Outliner.Entry>	generate(Indexer idx, java.lang.String abspath) Create an outline for a file in the index.
java.util.List<Outliner.Entry>	generate(Scope scope, java.lang.String path) Create an outline for a symbol table.

Methods inherited from class java.lang.Object

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

Constructor Detail

Outliner

public Outliner()

Method Detail

generate

public java.util.List<Outliner.Entry> generate(Indexer idx,
                                               java.lang.String abspath)
                                        throws java.lang.Exception

Create an outline for a file in the index.

Parameters:

idx - index holding the file scope

abspath - the file for which to build the outline

Returns:

a list of entries constituting the file outline. Returns an empty list if the indexer hasn't indexed that path.

Throws:

java.lang.Exception

generate

public java.util.List<Outliner.Entry> generate(Scope scope,
                                               java.lang.String path)

Create an outline for a symbol table.

Parameters:

scope - the file scope

path - the file for which we're building the outline

Returns:

a list of entries constituting the outline