Package org.gvsig.app.project

Interface DocumentsContainer

All Superinterfaces:
Iterable<Document>, org.gvsig.tools.observer.Observable
All Known Subinterfaces:
Project
All Known Implementing Classes:
DefaultProject
public interface DocumentsContainer extends Iterable<Document>, org.gvsig.tools.observer.Observable

  • Method Details

    • getDocuments

      List<Document> getDocuments(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

      List<Document> getDocuments()
      Utility method that call getDocuments(Predicatefilter).
      Returns:
      List of project documents.

    • getDocuments

      List<Document> getDocuments(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.

    • getDocuments

      List<Document> getDocuments(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.

    • 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

    • getDocument

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

    • getActiveDocument

      Document getActiveDocument()

    • getActiveDocument

      Document getActiveDocument(Class<? extends Document> documentClass)

    • getFirstDocument

      Document getFirstDocument(Class<? extends Document> documentClass)

    • getActiveDocument

      Document getActiveDocument(String documentTypeName)

    • getActiveWindow

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

    • createDocument

      Document createDocument(String type)

    • getOpenDocuments

      List<Document> getOpenDocuments(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

      List<Document> getOpenDocuments(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

      List<Document> getOpenDocuments(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.