org.gvsig.app.project

Interface DocumentsContainer

All Superinterfaces:

Iterable<Document>, Observable

All Known Subinterfaces:

Project, Project

All Known Implementing Classes:

DefaultProject

public interface DocumentsContainer
extends Iterable<Document>, Observable

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocument(Document document) Adds a document to the project
Document	createDocument(String type)
Document	getActiveDocument()
Document	getActiveDocument(Class<? extends Document> documentClass)
Document	getActiveDocument(String documentTypeName)
Document	getDocument(String name) Returns the document with the name specified by name.
Document	getDocument(String name, String type) Returns the document of the type indicated and the name specified by name.
List<Document>	getDocuments() Return a list of documents in the project.
List<Document>	getDocuments(String type) Return a list with all documents of especified type.
boolean	isEmpty()
Iterator<Document>	iterator()
void	removeDocument(Document document) Remove a document of the project

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Method Detail

getDocuments

List<Document> getDocuments()

Return a list of documents in the project.

Returns:

documents as List of IProjectDocument

getDocuments

List<Document> getDocuments(String type)

Return a list with all documents of especified type.

Parameters:

type - of document

Returns:

List of IProjectDocument

addDocument

void addDocument(Document document)

Adds a document to the project

Parameters:

document - as Document

removeDocument

void removeDocument(Document document)

Remove a document of the project

Parameters:

document - as Document

iterator

Iterator<Document> iterator()

Specified by:

iterator in interface Iterable<Document>

isEmpty

boolean isEmpty()

getDocument

Document getDocument(String name,
                   String type)

Returns the document of the type indicated and the name specified by name. If documnt don't exists return null

Parameters:

name - name of the document to retrieve

type - name of the type of document to retrieve

Returns:

Documento

getDocument

Document getDocument(String name)

Returns the document with the name specified by name. If documnt don't exists return null

Parameters:

name -

Returns:

Document with the name specified by name

getActiveDocument

Document getActiveDocument()

getActiveDocument

Document getActiveDocument(Class<? extends Document> documentClass)

getActiveDocument

Document getActiveDocument(String documentTypeName)

createDocument

Document createDocument(String type)