org.gvsig.app.project.documents

Class AbstractDocumentManager

java.lang.Object

org.gvsig.app.project.documents.AbstractDocumentManager

All Implemented Interfaces:

DocumentManager, org.gvsig.fmap.mapcontext.layers.ExtendedPropertiesSupport, org.gvsig.tools.extensionpoint.ExtensionBuilder, org.gvsig.tools.observer.Observable, org.gvsig.tools.observer.Observer, org.gvsig.tools.observer.WeakReferencingObservable, org.gvsig.tools.persistence.PersistenceFactory

Direct Known Subclasses:

ViewManager

public abstract class AbstractDocumentManager
extends java.lang.Object
implements DocumentManager, org.gvsig.tools.observer.Observer

Factory of ProjectDocument.

Field Summary

Fields inherited from interface org.gvsig.app.project.documents.DocumentManager

NOTIFY_AFTER_CREATEDOCUMENT, NOTIFY_AFTER_CREATEMAINWINDOW, NOTIFY_AFTER_CREATEPROPERTIESWINDOW, NOTIFY_AFTER_GETMAINWINDOW, NOTIFY_AFTER_GETPROPERTIESWINDOW

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDocumentManager()

Method Summary

Modifier and Type	Method and Description
void	addObserver(org.gvsig.tools.observer.Observer o)
java.lang.Object	create()
java.lang.Object	create(java.util.Map args)
java.lang.Object	create(java.lang.Object[] args)
AbstractDocument	createDocumentByUser() Uses a gui to be able from the characteristics that we want a ProjectDocument
java.util.Iterator<? extends Document>	createDocumentsByUser() Uses a gui to be able from the characteristics that we want a ProjectDocument
java.util.Iterator<? extends Document>	createDocumentsByUser(org.gvsig.tools.util.Invocable whenDocumentsLoaded)
protected IDocumentWindow	createDocumentWindow(Document document)
java.lang.Object	createFromState(org.gvsig.tools.persistence.PersistentState state)
void	deleteObserver(org.gvsig.tools.observer.Observer o)
void	deleteObservers()
boolean	existName(Project project, java.lang.String documentName) Return true if the name exists to another document.
java.lang.Class	getClassOfDocument()
java.util.List<org.gvsig.tools.dynobject.DynStruct>	getDefinitions()
protected abstract java.lang.Class	getDocumentClass() Return the class or interface for the documents managed by this factory.
java.lang.String	getDomainName()
java.lang.String	getDomainURL()
java.util.Map	getExtendedProperties()
javax.swing.ImageIcon	getIcon() Returns the icon for the type of document.
javax.swing.ImageIcon	getIconSelected() Returns the icon for the type of document when is selected
javax.swing.JComponent	getMainComponent(Document doc) Devuelbe el JComponent que se corresponde con el documento indicado.
javax.swing.JComponent	getMainComponent(DocumentsContainer container, Document doc) Create a new JComponent for the document or if already exists in the specified container, return this.
org.gvsig.andami.ui.mdiManager.IWindow	getMainWindow(Document doc) Return the main window asociated to the passed document.
org.gvsig.andami.ui.mdiManager.IWindow	getMainWindow(Document doc, WindowLayout layout) Return the main window asociated to the document.
java.lang.Class	getManagedClass(java.lang.Object object)
java.lang.Class	getManagedClass(org.gvsig.tools.persistence.PersistentState state)
java.lang.Class	getManagedClass(java.lang.String name)
java.util.List	getManagedClasses()
java.lang.String	getManagedClassName(java.lang.Object object)
int	getPriority() Returns the type of document priority.
org.gvsig.andami.ui.mdiManager.IWindow	getPropertiesWindow(Document doc) Return the windows properties asociated to the document.
java.lang.Object	getProperty(java.lang.Object key)
java.lang.String	getTitle() Returns the title of type of document.
boolean	hasMainWindow(Document doc)
void	loadFromState(org.gvsig.tools.persistence.PersistentState state, java.lang.Object object)
boolean	manages(java.lang.Class theClass)
boolean	manages(org.gvsig.tools.persistence.PersistentState state)
protected org.gvsig.tools.observer.Notification	notifyObservers(java.lang.String type, Document doc)
protected org.gvsig.tools.observer.Notification	notifyObservers(java.lang.String type, org.gvsig.andami.ui.mdiManager.IWindow doc)
void	registerMainComponent(DocumentsContainer container, Document doc, javax.swing.JComponent component)
void	saveToState(org.gvsig.tools.persistence.PersistentState state, java.lang.Object obj)
void	setProperty(java.lang.Object key, java.lang.Object obj)
void	unregisterMainComponent(DocumentsContainer container, Document doc)
void	update(org.gvsig.tools.observer.Observable observable, java.lang.Object notification)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.app.project.documents.DocumentManager

createDocument, getMainWindowClass, getTypeName

Methods inherited from interface org.gvsig.tools.persistence.PersistenceFactory

getDefinition, manages

Constructor Detail

AbstractDocumentManager

protected AbstractDocumentManager()

Method Detail

addObserver

public void addObserver(org.gvsig.tools.observer.Observer o)

Specified by:

addObserver in interface org.gvsig.tools.observer.Observable

create

public java.lang.Object create()

Specified by:

create in interface org.gvsig.tools.extensionpoint.ExtensionBuilder

See Also:

ExtensionBuilder

create

public java.lang.Object create(java.util.Map args)

Specified by:

create in interface org.gvsig.tools.extensionpoint.ExtensionBuilder

See Also:

ExtensionBuilder

create

public java.lang.Object create(java.lang.Object[] args)

Specified by:

create in interface org.gvsig.tools.extensionpoint.ExtensionBuilder

See Also:

ExtensionBuilder

createDocumentByUser

public AbstractDocument createDocumentByUser()

Description copied from interface: DocumentManager

Uses a gui to be able from the characteristics that we want a ProjectDocument

Specified by:

createDocumentByUser in interface DocumentManager

Returns:

a new Document

createDocumentsByUser

public java.util.Iterator<? extends Document> createDocumentsByUser()

Description copied from interface: DocumentManager

Uses a gui to be able from the characteristics that we want a ProjectDocument

Specified by:

createDocumentsByUser in interface DocumentManager

Returns:

the created documents

createDocumentsByUser

public java.util.Iterator<? extends Document> createDocumentsByUser(org.gvsig.tools.util.Invocable whenDocumentsLoaded)

Specified by:

createDocumentsByUser in interface DocumentManager

createDocumentWindow

protected IDocumentWindow createDocumentWindow(Document document)

createFromState

public java.lang.Object createFromState(org.gvsig.tools.persistence.PersistentState state)
                                 throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

createFromState in interface org.gvsig.tools.persistence.PersistenceFactory

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

deleteObserver

public void deleteObserver(org.gvsig.tools.observer.Observer o)

Specified by:

deleteObserver in interface org.gvsig.tools.observer.Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface org.gvsig.tools.observer.Observable

existName

public boolean existName(Project project,
                         java.lang.String documentName)

Return true if the name exists to another document.

Specified by:

existName in interface DocumentManager

Parameters:

project -

documentName -

Returns:

True if the name exists.

getClassOfDocument

public java.lang.Class getClassOfDocument()

Specified by:

getClassOfDocument in interface DocumentManager

getDefinitions

public java.util.List<org.gvsig.tools.dynobject.DynStruct> getDefinitions()

Specified by:

getDefinitions in interface org.gvsig.tools.persistence.PersistenceFactory

getDocumentClass

protected abstract java.lang.Class getDocumentClass()

Return the class or interface for the documents managed by this factory.

Returns:

The document class;

getDomainName

public java.lang.String getDomainName()

Specified by:

getDomainName in interface org.gvsig.tools.persistence.PersistenceFactory

getDomainURL

public java.lang.String getDomainURL()

Specified by:

getDomainURL in interface org.gvsig.tools.persistence.PersistenceFactory

getExtendedProperties

public java.util.Map getExtendedProperties()

Specified by:

getExtendedProperties in interface org.gvsig.fmap.mapcontext.layers.ExtendedPropertiesSupport

getIcon

public javax.swing.ImageIcon getIcon()

Returns the icon for the type of document.

Specified by:

getIcon in interface DocumentManager

Returns:

Image.

getIconSelected

public javax.swing.ImageIcon getIconSelected()

Returns the icon for the type of document when is selected

Specified by:

getIconSelected in interface DocumentManager

Returns:

Image.

getMainComponent

public javax.swing.JComponent getMainComponent(Document doc)

Description copied from interface: DocumentManager

Devuelbe el JComponent que se corresponde con el documento indicado. Si la ventana activa se corresponde con este documento, devuelbe el JComponent asociado a esa ventana. Si no se corresponde con la ventana activa, pero esta es un contenedor de documentos le pide a este el componente asociado al documento requerido y si lo encuentra lo devuelve. En otro caso develbe null.

Specified by:

getMainComponent in interface DocumentManager

Returns:

el JComponent asociado a doc

getMainComponent

public javax.swing.JComponent getMainComponent(DocumentsContainer container,
                                               Document doc)

Description copied from interface: DocumentManager

Create a new JComponent for the document or if already exists in the specified container, return this.

Specified by:

getMainComponent in interface DocumentManager

Returns:

getMainWindow

public org.gvsig.andami.ui.mdiManager.IWindow getMainWindow(Document doc)

Description copied from interface: DocumentManager

Return the main window asociated to the passed document. If the window alreade exists return it. If not, a new window is created.

Specified by:

getMainWindow in interface DocumentManager

Returns:

Window asociated to document

getMainWindow

public org.gvsig.andami.ui.mdiManager.IWindow getMainWindow(Document doc,
                                                            WindowLayout layout)

Description copied from interface: DocumentManager

Return the main window asociated to the document.

Specified by:

getMainWindow in interface DocumentManager

Returns:

Window asociated to document

getManagedClass

public java.lang.Class getManagedClass(java.lang.Object object)

Specified by:

getManagedClass in interface org.gvsig.tools.persistence.PersistenceFactory

getManagedClass

public java.lang.Class getManagedClass(org.gvsig.tools.persistence.PersistentState state)

Specified by:

getManagedClass in interface org.gvsig.tools.persistence.PersistenceFactory

getManagedClass

public java.lang.Class getManagedClass(java.lang.String name)

Specified by:

getManagedClass in interface org.gvsig.tools.persistence.PersistenceFactory

getManagedClasses

public java.util.List getManagedClasses()

Specified by:

getManagedClasses in interface org.gvsig.tools.persistence.PersistenceFactory

getManagedClassName

public java.lang.String getManagedClassName(java.lang.Object object)

Specified by:

getManagedClassName in interface org.gvsig.tools.persistence.PersistenceFactory

getPriority

public int getPriority()

Returns the type of document priority. This priority is used when order document factories in UI.

Specified by:

getPriority in interface DocumentManager

Returns:

Priority.

getPropertiesWindow

public org.gvsig.andami.ui.mdiManager.IWindow getPropertiesWindow(Document doc)

Description copied from interface: DocumentManager

Return the windows properties asociated to the document.

Specified by:

getPropertiesWindow in interface DocumentManager

Returns:

getProperty

public java.lang.Object getProperty(java.lang.Object key)

Specified by:

getProperty in interface org.gvsig.fmap.mapcontext.layers.ExtendedPropertiesSupport

getTitle

public java.lang.String getTitle()

Returns the title of type of document.

Specified by:

getTitle in interface DocumentManager

Returns:

String title for type of document

hasMainWindow

public boolean hasMainWindow(Document doc)

Specified by:

hasMainWindow in interface DocumentManager

loadFromState

public void loadFromState(org.gvsig.tools.persistence.PersistentState state,
                          java.lang.Object object)
                   throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

loadFromState in interface org.gvsig.tools.persistence.PersistenceFactory

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

manages

public boolean manages(java.lang.Class theClass)

Specified by:

manages in interface org.gvsig.tools.persistence.PersistenceFactory

manages

public boolean manages(org.gvsig.tools.persistence.PersistentState state)

Specified by:

manages in interface org.gvsig.tools.persistence.PersistenceFactory

notifyObservers

protected org.gvsig.tools.observer.Notification notifyObservers(java.lang.String type,
                                                                Document doc)

notifyObservers

protected org.gvsig.tools.observer.Notification notifyObservers(java.lang.String type,
                                                                org.gvsig.andami.ui.mdiManager.IWindow doc)

registerMainComponent

public void registerMainComponent(DocumentsContainer container,
                                  Document doc,
                                  javax.swing.JComponent component)

Specified by:

registerMainComponent in interface DocumentManager

saveToState

public void saveToState(org.gvsig.tools.persistence.PersistentState state,
                        java.lang.Object obj)
                 throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

saveToState in interface org.gvsig.tools.persistence.PersistenceFactory

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

setProperty

public void setProperty(java.lang.Object key,
                        java.lang.Object obj)

Specified by:

setProperty in interface org.gvsig.fmap.mapcontext.layers.ExtendedPropertiesSupport

unregisterMainComponent

public void unregisterMainComponent(DocumentsContainer container,
                                    Document doc)

Specified by:

unregisterMainComponent in interface DocumentManager

update

public void update(org.gvsig.tools.observer.Observable observable,
                   java.lang.Object notification)

Specified by:

update in interface org.gvsig.tools.observer.Observer