org.gvsig.app.project

Interface DocumentsContainer

All Superinterfaces:

java.lang.Iterable<Document>, org.gvsig.tools.observer.Observable

All Known Subinterfaces:

Project

All Known Implementing Classes:

DefaultProject

public interface DocumentsContainer
extends java.lang.Iterable<Document>, org.gvsig.tools.observer.Observable

Method Summary

Modifier and Type	Method and Description
void	addDocument(Document document) Adds a document to the project
Document	createDocument(java.lang.String type)
Document	getActiveDocument()
Document	getActiveDocument(java.lang.Class<? extends Document> documentClass)
Document	getActiveDocument(java.lang.String documentTypeName)
org.gvsig.andami.ui.mdiManager.IWindow	getActiveWindow(java.lang.Class<? extends Document> documentClass)
Document	getDocument(java.util.function.Predicate<Document> condition) Returns the first document that fit the condition specified.
Document	getDocument(java.lang.String name) Returns the document with the name specified by name.
Document	getDocument(java.lang.String name, java.lang.String type) Returns the document of the type indicated and the name specified by name.
java.util.List<Document>	getDocuments() Utility method that call getDocuments(Predicatefilter).
java.util.List<Document>	getDocuments(java.lang.Class<? extends Document> documentClass) Utility method that call getDocuments(Predicatefilter).
java.util.List<Document>	getDocuments(java.util.function.Predicate<Document> filter) Return a list of all the documents of the project that meet the specified filter.The list of documents will be ordered alphabetically by the name of the document.
java.util.List<Document>	getDocuments(java.lang.String type) Utility method that call getDocuments(Predicatefilter).
Document	getFirstDocument(java.lang.Class<? extends Document> documentClass)
java.util.List<Document>	getOpenDocuments(java.lang.Class<? extends Document> documentClass) Utility method that call getOpenDocuments(Predicatefilter).
java.util.List<Document>	getOpenDocuments(java.util.function.Predicate<Document> filter) Return a list of all open documents of the project that meet the specified filter.The document list follows the same order as the windows of these, being the first in case of complying with the filter, the corresponding to the active window.
java.util.List<Document>	getOpenDocuments(java.lang.String type) Utility method that call getOpenDocuments(Predicatefilter).
boolean	isEmpty()
java.util.Iterator<Document>	iterator()
void	removeDocument(Document document) Remove a document of the project

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

addObserver, deleteObserver, deleteObservers

Method Detail

addDocument

void addDocument(Document document)

Adds a document to the project

Parameters:

document - as Document

createDocument

Document createDocument(java.lang.String type)

getActiveDocument

Document getActiveDocument()

getActiveDocument

Document getActiveDocument(java.lang.Class<? extends Document> documentClass)

getActiveDocument

Document getActiveDocument(java.lang.String documentTypeName)

getActiveWindow

org.gvsig.andami.ui.mdiManager.IWindow getActiveWindow(java.lang.Class<? extends Document> documentClass)

getDocument

Document getDocument(java.util.function.Predicate<Document> condition)

Returns the first document that fit the condition specified. If documnt don't exists return null

Parameters:

condition -

Returns:

Document that fit the condition specified.

getDocument

Document getDocument(java.lang.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

getDocument

Document getDocument(java.lang.String name,
                     java.lang.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

getDocuments

java.util.List<Document> getDocuments()

Utility method that call getDocuments(Predicatefilter).

Returns:

List of project documents.

getDocuments

java.util.List<Document> getDocuments(java.lang.Class<? extends Document> documentClass)

Utility method that call getDocuments(Predicatefilter).

Parameters:

documentClass - of the documents that should return.

Returns:

List of project documents of this document class.

getDocuments

java.util.List<Document> getDocuments(java.util.function.Predicate<Document> filter)

Return a list of all the documents of the project that meet the specified filter.The list of documents will be ordered alphabetically by the name of the document. If filter is null return all documents.

Parameters:

filter - that determines what documents should be returned.

Returns:

List of project document that meet the filter.

getDocuments

java.util.List<Document> getDocuments(java.lang.String type)

Utility method that call getDocuments(Predicatefilter).

Parameters:

type - of the documents that should return.

Returns:

List of project documents of this document class.

getFirstDocument

Document getFirstDocument(java.lang.Class<? extends Document> documentClass)

getOpenDocuments

java.util.List<Document> getOpenDocuments(java.lang.Class<? extends Document> documentClass)

Utility method that call getOpenDocuments(Predicatefilter).

Parameters:

documentClass - of the documents that should return.

Returns:

List of project document of this document class.

getOpenDocuments

java.util.List<Document> getOpenDocuments(java.util.function.Predicate<Document> filter)

Return a list of all open documents of the project that meet the specified filter.The document list follows the same order as the windows of these, being the first in case of complying with the filter, the corresponding to the active window.

Parameters:

filter - that determines what documents should be returned.

Returns:

List of project document that meet the filter.

getOpenDocuments

java.util.List<Document> getOpenDocuments(java.lang.String type)

Utility method that call getOpenDocuments(Predicatefilter).

Parameters:

type - of the documents that should return.

Returns:

List of project document of this document class.

isEmpty

boolean isEmpty()

iterator

java.util.Iterator<Document> iterator()

Specified by:

iterator in interface java.lang.Iterable<Document>

removeDocument

void removeDocument(Document document)

Remove a document of the project

Parameters:

document - as Document