org.gvsig.app.project.documents

Class AbstractDocumentManager

java.lang.Object

org.gvsig.app.project.documents.AbstractDocumentManager

All Implemented Interfaces:

DocumentManager, ExtendedPropertiesSupport, ExtensionBuilder, Observable, Observer, WeakReferencingObservable, PersistenceFactory

Direct Known Subclasses:

DefaultLayoutManager, PortableViewDocumentManager, TableManager, ViewManager

public abstract class AbstractDocumentManager
extends java.lang.Object
implements DocumentManager, 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(Observer o)
java.lang.Object	create() Crea una instancia de la extension y la retorna.
java.lang.Object	create(java.util.Map args)
java.lang.Object	create(java.lang.Object[] args) Crea una instancia de la extension y la retorna.
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(Invocable whenDocumentsLoaded)
protected IDocumentWindow	createDocumentWindow(Document document)
java.lang.Object	createFromState(PersistentState state) Create an instance of the object represented by the state.
void	deleteObserver(Observer o)
void	deleteObservers()
boolean	existName(Project project, java.lang.String documentName) Deprecated. use instead project.getProjectDocument
java.lang.Class	getClassOfDocument()
java.util.List<DynStruct>	getDefinitions() Return a List of the definition managed by this factory where the key is className and value is definition
protected abstract java.lang.Class	getDocumentClass() Return the class or interface for the documents managed by this factory.
java.lang.String	getDomainName() Returns the domain name of the objects persisted by this factory.
java.lang.String	getDomainURL() Returns the domain URL to use for the schema.
java.util.Map	getExtendedProperties() Returns a hash map with all new properties associated to this layer.
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.
IWindow	getMainWindow(Document doc) Return the main window asociated to the passed document.
IWindow	getMainWindow(Document doc, WindowLayout layout) Return the main window asociated to the document.
java.lang.Class	getManagedClass(java.lang.Object object) Return the class or interface the factory asociate to the object.
java.lang.Class	getManagedClass(PersistentState state) Return the class or interface the factory asociate to the object.
java.lang.Class	getManagedClass(java.lang.String name) Return the class or interface the factory asociate to the java class name.
java.util.List	getManagedClasses() Return the list of classes or interfaces managed by this factory.
java.lang.String	getManagedClassName(java.lang.Object object) Return the name class or interface the factory asociate to the object.
int	getPriority() Returns the type of document priority.
IWindow	getPropertiesWindow(Document doc) Return the windows properties asociated to the document.
java.lang.Object	getProperty(java.lang.Object key) Returns a reference to an object (property) associated to this layer.
java.lang.String	getTitle() Returns the title of type of document.
boolean	hasMainWindow(Document doc)
void	loadFromState(PersistentState state, java.lang.Object object) Load a instance of classToUse from state data.
boolean	manages(java.lang.Class theClass) Informs if theClass is managed by this factory.
boolean	manages(PersistentState state) Informs if this factory can recreate the object represented by state.
protected Notification	notifyObservers(java.lang.String type, Document doc)
protected Notification	notifyObservers(java.lang.String type, IWindow doc)
void	registerMainComponent(DocumentsContainer container, Document doc, javax.swing.JComponent component)
void	saveToState(PersistentState state, java.lang.Object obj) Fill state with data to persist of obj.
void	setProperty(java.lang.Object key, java.lang.Object obj) Inserts an object as a property to this layer.
void	unregisterMainComponent(DocumentsContainer container, Document doc)
void	update(Observable observable, java.lang.Object notification) Called whenever a Observable object is changed and this Observer has registered on it to receive notifications.

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

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.

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.

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

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(Invocable whenDocumentsLoaded)

Specified by:

createDocumentsByUser in interface DocumentManager

create

public java.lang.Object create()

Description copied from interface: ExtensionBuilder

Crea una instancia de la extension y la retorna.

Specified by:

create in interface ExtensionBuilder

Returns:

See Also:

ExtensionBuilder

create

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

Description copied from interface: ExtensionBuilder

Crea una instancia de la extension y la retorna.
En args recibira la lista de argumeentos a utilizar para crear la extension.

Specified by:

create in interface ExtensionBuilder

Returns:

See Also:

ExtensionBuilder

create

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

Specified by:

create in interface ExtensionBuilder

See Also:

ExtensionBuilder

getMainWindow

public 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 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

hasMainWindow

public boolean hasMainWindow(Document doc)

Specified by:

hasMainWindow in interface DocumentManager

getPropertiesWindow

public IWindow getPropertiesWindow(Document doc)

Description copied from interface: DocumentManager

Return the windows properties asociated to the document.

Specified by:

getPropertiesWindow in interface DocumentManager

Returns:

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:

unregisterMainComponent

public void unregisterMainComponent(DocumentsContainer container,
                                    Document doc)

Specified by:

unregisterMainComponent in interface DocumentManager

registerMainComponent

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

Specified by:

registerMainComponent in interface DocumentManager

existName

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

Deprecated. use instead project.getProjectDocument

Return true if the name exists to another document.

Specified by:

existName in interface DocumentManager

Parameters:

project -

documentName -

Returns:

True if the name exists.

getDocumentClass

protected abstract java.lang.Class getDocumentClass()

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

Returns:

The document class;

getClassOfDocument

public java.lang.Class getClassOfDocument()

Specified by:

getClassOfDocument in interface DocumentManager

createFromState

public java.lang.Object createFromState(PersistentState state)
                                 throws PersistenceException

Description copied from interface: PersistenceFactory

Create an instance of the object represented by the state. This method can't call PersistenceFactory.loadFromState(PersistentState, Object) only create the object.

Specified by:

createFromState in interface PersistenceFactory

Returns:

the object

Throws:

PersistenceException

loadFromState

public void loadFromState(PersistentState state,
                          java.lang.Object object)
                   throws PersistenceException

Description copied from interface: PersistenceFactory

Load a instance of classToUse from state data.

Specified by:

loadFromState in interface PersistenceFactory

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state,
                        java.lang.Object obj)
                 throws PersistenceException

Description copied from interface: PersistenceFactory

Fill state with data to persist of obj.

Specified by:

saveToState in interface PersistenceFactory

Throws:

PersistenceException

manages

public boolean manages(java.lang.Class theClass)

Description copied from interface: PersistenceFactory

Informs if theClass is managed by this factory.

Specified by:

manages in interface PersistenceFactory

Returns:

true if the class is managed by the factory.

manages

public boolean manages(PersistentState state)

Description copied from interface: PersistenceFactory

Informs if this factory can recreate the object represented by state.

Specified by:

manages in interface PersistenceFactory

Returns:

getDefinitions

public java.util.List<DynStruct> getDefinitions()

Description copied from interface: PersistenceFactory

Return a List of the definition managed by this factory where the key is className and value is definition

Specified by:

getDefinitions in interface PersistenceFactory

Returns:

Map

getDomainName

public java.lang.String getDomainName()

Description copied from interface: PersistenceFactory

Returns the domain name of the objects persisted by this factory.

Specified by:

getDomainName in interface PersistenceFactory

Returns:

the domain name

getDomainURL

public java.lang.String getDomainURL()

Description copied from interface: PersistenceFactory

Returns the domain URL to use for the schema.

Specified by:

getDomainURL in interface PersistenceFactory

Returns:

the domain URL

getManagedClasses

public java.util.List getManagedClasses()

Description copied from interface: PersistenceFactory

Return the list of classes or interfaces managed by this factory. Can return null if factory not use it.

Specified by:

getManagedClasses in interface PersistenceFactory

Returns:

List of interfaces the factory manage

getManagedClass

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

Description copied from interface: PersistenceFactory

Return the class or interface the factory asociate to the object. Can return null if factory not asociate an interface to the object.

Specified by:

getManagedClass in interface PersistenceFactory

Returns:

interface the factory manage asociated to the object.

getManagedClass

public java.lang.Class getManagedClass(PersistentState state)

Description copied from interface: PersistenceFactory

Return the class or interface the factory asociate to the object. Can return null if factory not asociate an interface to the object.

Specified by:

getManagedClass in interface PersistenceFactory

Returns:

interface or class the factory manage asociated to the state.

getManagedClass

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

Description copied from interface: PersistenceFactory

Return the class or interface the factory asociate to the java class name. Can return null if factory not asociate an interface to that name.

Specified by:

getManagedClass in interface PersistenceFactory

Returns:

interface or class the factory manage asociated to the name.

getManagedClassName

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

Description copied from interface: PersistenceFactory

Return the name class or interface the factory asociate to the object. Can return null if factory not asociate an interface to the object.

Specified by:

getManagedClassName in interface PersistenceFactory

Returns:

interface the factory manage asociated to the object.

createDocumentWindow

protected IDocumentWindow createDocumentWindow(Document document)

update

public void update(Observable observable,
                   java.lang.Object notification)

Description copied from interface: Observer

Called whenever a Observable object is changed and this Observer has registered on it to receive notifications.

Implementations of this method will be called for each simple notification or, if a complex notification is created, for each of the child notifications.

In the latter case, don't assume any ordering in the notification between this Observer and other Observers listening to the same Observable.

In a complex notification scenario, if you want to receive only the complex notification and not each of the child notifications, just implement the ComplexObserver and prepare this method implementation to handle receiving DefaultComplexNotification instances as well as direct notification objects.

Specified by:

update in interface Observer

Parameters:

observable - the observable object.

notification - the notification data.

addObserver

public void addObserver(Observer o)

Specified by:

addObserver in interface Observable

deleteObserver

public void deleteObserver(Observer o)

Specified by:

deleteObserver in interface Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface Observable

notifyObservers

protected Notification notifyObservers(java.lang.String type,
                                       Document doc)

notifyObservers

protected Notification notifyObservers(java.lang.String type,
                                       IWindow doc)

getProperty

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

Description copied from interface: ExtendedPropertiesSupport

Returns a reference to an object (property) associated to this layer.

For example, you can attach a network definition to key "network" and check if a layer has a network loaded using getAssociatedObject("network") and that it's not null.

Specified by:

getProperty in interface ExtendedPropertiesSupport

Parameters:

key - the key associated to the property

Returns:

null if key is not found

See Also:

ExtendedPropertiesSupport.getExtendedProperties(), ExtendedPropertiesSupport.setProperty(Object, Object)

setProperty

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

Description copied from interface: ExtendedPropertiesSupport

Inserts an object as a property to this layer.

Specified by:

setProperty in interface ExtendedPropertiesSupport

Parameters:

key - the key associated to the property

obj - the property

See Also:

ExtendedPropertiesSupport.getProperty(Object), ExtendedPropertiesSupport.getExtendedProperties()

getExtendedProperties

public java.util.Map getExtendedProperties()

Description copied from interface: ExtendedPropertiesSupport

Returns a hash map with all new properties associated to this layer.

Specified by:

getExtendedProperties in interface ExtendedPropertiesSupport

Returns:

hash table with the added properties

See Also:

ExtendedPropertiesSupport.getProperty(Object), ExtendedPropertiesSupport.setProperty(Object, Object)