net.sf.openschema

Class DocumentPlan

java.lang.Object

net.sf.openschema.DocumentPlan

public class DocumentPlan
extends Object

A document plan, the output of document structuring schemata. In this case, a document plan is a list of paragraph. Each paragraph is a list of aggregation segments. Each aggregation segment is a list of clauses.

Author:

Pablo Ariel Duboue (pablo.duboue@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected List<List<List<Map<String,Object>>>>	paragraphs The document plan itself.

Constructor Summary

Constructors

Constructor and Description
DocumentPlan() Empty constructor.

Method Summary

Modifier and Type	Method and Description
void	addAggrBoundary() Closes the current aggregation segment and creates a new one.
void	addClause(Map<String,Object> clause) Adds a new clause to the open paragraph and aggregation segment.
void	addParBoundary() Closes the current aggregation segment (deletes it if it's empty), closes the current paragraph and creates a new paragraph with a new aggregation segment inside.
List<List<List<Map<String,Object>>>>	getParagraphs() Obtain the list of paragraphs.
String	toString() String rendering, for debugging purposes.

Methods inherited from class java.lang.Object

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

Field Detail

paragraphs

protected List<List<List<Map<String,Object>>>> paragraphs

The document plan itself.

Constructor Detail

DocumentPlan

public DocumentPlan()

Empty constructor.

Method Detail

addClause

public void addClause(Map<String,Object> clause)

Adds a new clause to the open paragraph and aggregation segment.

addParBoundary

public void addParBoundary()

Closes the current aggregation segment (deletes it if it's empty), closes the current paragraph and creates a new paragraph with a new aggregation segment inside.

addAggrBoundary

public void addAggrBoundary()

Closes the current aggregation segment and creates a new one.

getParagraphs

public List<List<List<Map<String,Object>>>> getParagraphs()

Obtain the list of paragraphs.

toString

public String toString()

String rendering, for debugging purposes.

Overrides:

toString in class Object