org.gvsig.app.project.documents

Class AbstractDocument

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.app.project.documents.AbstractDocument

All Implemented Interfaces:

java.io.Serializable, Document, org.gvsig.tools.dispose.Disposable, org.gvsig.tools.persistence.Persistent, org.gvsig.tools.util.Contains, org.gvsig.tools.util.PropertiesSupport

Direct Known Subclasses:

BaseViewDocument

public abstract class AbstractDocument
extends org.gvsig.tools.dispose.impl.AbstractDisposable
implements java.io.Serializable, org.gvsig.tools.persistence.Persistent, Document

Clase base de los elementos del proyecto (mapas, tablas y vistas)

Author:

2006-2009 Jose Manuel Vivo, 2005- Vicente Caballero, 2009- Joaquin del Cerro

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.beans.PropertyChangeSupport	change
static java.lang.String	PERSISTENCE_DEFINITION_NAME

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

ACCESS_DOCUMENT_AUTHORIZATION

Constructor Summary

Constructors

Constructor and Description
AbstractDocument() Creates a new ProjectElement object.
AbstractDocument(DocumentManager factory)

Method Summary

Modifier and Type	Method and Description
void	addListener(ProjectDocumentListener listener) Register a ProjectDocumentListener.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a listener to monitor the changes in the properties of the document
void	afterAdd()
void	afterRemove()
boolean	contains(java.lang.Object value)
protected void	doDispose()
java.lang.String	exportDocumentAsText()
java.lang.String	getComment() Gets the comments asociateds to the document
java.lang.String	getCreationDate() Get the creation date of the document.
DocumentManager	getFactory()
javax.swing.JComponent	getMainComponent() Return the main JComponent associated to this document.
org.gvsig.andami.ui.mdiManager.IWindow	getMainWindow() Return the main window associated to this document.
java.lang.String	getName() return the name of the document
boolean	getOpenWhenTheUserCreates()
java.lang.String	getOwner() Get the creator name of the document.
Project	getProject()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
org.gvsig.andami.ui.mdiManager.IWindow	getPropertiesWindow()
java.lang.Object	getProperty(java.lang.String name)
java.lang.String	getTypeName() Return the name of the type of documents
WindowLayout	getWindowLayout()
boolean	isAvailable()
boolean	isLocked() Tells whether if this project's element is locked/protected or not.
boolean	isModified()
boolean	isTemporary()
void	loadFromState(org.gvsig.tools.persistence.PersistentState state)
void	lock() Locks this project element protecting it from deleting from the project.
void	raiseEventCreateWindow(org.gvsig.andami.ui.mdiManager.IWindow window) Throw this event when a new window is created
void	refresh()
static void	registerPersistent()
void	saveToState(org.gvsig.tools.persistence.PersistentState state)
void	setComment(java.lang.String string) Gets the comments asociateds to the document
void	setCreationDate(java.lang.String string) Set the creation date of the document.
void	setModified(boolean modified)
void	setName(java.lang.String name) Sets the nane of the document
void	setOwner(java.lang.String string) Sets the creator name of the document
void	setProject(Project project)
void	setProperty(java.lang.String name, java.lang.Object value)
void	setStateFromText(java.lang.String text)
void	setWindowLayout(WindowLayout layout)
java.lang.String	toString()
void	unlock() Unlocks this element.

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

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

Field Detail

change

protected java.beans.PropertyChangeSupport change

PERSISTENCE_DEFINITION_NAME

public static final java.lang.String PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractDocument

public AbstractDocument()

Creates a new ProjectElement object.

AbstractDocument

public AbstractDocument(DocumentManager factory)

Method Detail

addListener

public void addListener(ProjectDocumentListener listener)

Register a ProjectDocumentListener.

Specified by:

addListener in interface Document

Parameters:

listener - ProjectDocumentListener

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a listener to monitor the changes in the properties of the document

Specified by:

addPropertyChangeListener in interface Document

Parameters:

listener -

afterAdd

public void afterAdd()

Specified by:

afterAdd in interface Document

afterRemove

public void afterRemove()

Specified by:

afterRemove in interface Document

contains

public boolean contains(java.lang.Object value)

Specified by:

contains in interface org.gvsig.tools.util.Contains

doDispose

protected void doDispose()
                  throws org.gvsig.tools.exception.BaseException

Specified by:

doDispose in class org.gvsig.tools.dispose.impl.AbstractDisposable

Throws:

org.gvsig.tools.exception.BaseException

exportDocumentAsText

public java.lang.String exportDocumentAsText()

getComment

public java.lang.String getComment()

Gets the comments asociateds to the document

Specified by:

getComment in interface Document

Returns:

comments as String

getCreationDate

public java.lang.String getCreationDate()

Get the creation date of the document.

Specified by:

getCreationDate in interface Document

Returns:

creation date as String

getFactory

public DocumentManager getFactory()

Specified by:

getFactory in interface Document

getMainComponent

public javax.swing.JComponent getMainComponent()

Description copied from interface: Document

Return the main JComponent associated to this document. Is a tutility method, is equivalent to: this.getFactory().getMainComponent(doc)

Specified by:

getMainComponent in interface Document

Returns:

the JComponent associated to this document

getMainWindow

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

Description copied from interface: Document

Return the main window associated to this document. Is a tutility method, is equivalent to: this.getFactory().getMainWindow(doc)

Specified by:

getMainWindow in interface Document

Returns:

the IWindow associated to this document

getName

public java.lang.String getName()

return the name of the document

Specified by:

getName in interface Document

Returns:

name as String

getOpenWhenTheUserCreates

public boolean getOpenWhenTheUserCreates()

Specified by:

getOpenWhenTheUserCreates in interface Document

getOwner

public java.lang.String getOwner()

Get the creator name of the document.

Specified by:

getOwner in interface Document

Returns:

creator name as String

getProject

public Project getProject()

Specified by:

getProject in interface Document

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Specified by:

getProperties in interface org.gvsig.tools.util.PropertiesSupport

getPropertiesWindow

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

Specified by:

getPropertiesWindow in interface Document

getProperty

public java.lang.Object getProperty(java.lang.String name)

Specified by:

getProperty in interface org.gvsig.tools.util.PropertiesSupport

getTypeName

public java.lang.String getTypeName()

Return the name of the type of documents

Specified by:

getTypeName in interface Document

Returns:

name as String

getWindowLayout

public WindowLayout getWindowLayout()

Specified by:

getWindowLayout in interface Document

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface Document

isLocked

public boolean isLocked()

Tells whether if this project's element is locked/protected or not. A protected element cannot be removed from the current project.

Specified by:

isLocked in interface Document

Returns:

true if it is locked, false otherwise

See Also:

lock() and unlock() methods.

isModified

public boolean isModified()

Specified by:

isModified in interface Document

isTemporary

public boolean isTemporary()

Specified by:

isTemporary in interface Document

loadFromState

public void loadFromState(org.gvsig.tools.persistence.PersistentState state)
                   throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

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

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

lock

public void lock()

Locks this project element protecting it from deleting from the project.

Specified by:

lock in interface Document

raiseEventCreateWindow

public void raiseEventCreateWindow(org.gvsig.andami.ui.mdiManager.IWindow window)

Throw this event when a new window is created

Parameters:

window - IWindow created

refresh

public void refresh()

Specified by:

refresh in interface Document

registerPersistent

public static void registerPersistent()

saveToState

public void saveToState(org.gvsig.tools.persistence.PersistentState state)
                 throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

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

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

setComment

public void setComment(java.lang.String string)

Gets the comments asociateds to the document

Specified by:

setComment in interface Document

Parameters:

string -

setCreationDate

public void setCreationDate(java.lang.String string)

Set the creation date of the document.

Specified by:

setCreationDate in interface Document

Parameters:

string -

setModified

public void setModified(boolean modified)

Specified by:

setModified in interface Document

setName

public void setName(java.lang.String name)

Sets the nane of the document

Specified by:

setName in interface Document

Parameters:

name - as string

setOwner

public void setOwner(java.lang.String string)

Sets the creator name of the document

Specified by:

setOwner in interface Document

Parameters:

string -

setProject

public void setProject(Project project)

Specified by:

setProject in interface Document

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Specified by:

setProperty in interface org.gvsig.tools.util.PropertiesSupport

setStateFromText

public void setStateFromText(java.lang.String text)

setWindowLayout

public void setWindowLayout(WindowLayout layout)

Specified by:

setWindowLayout in interface Document

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

unlock

public void unlock()

Unlocks this element. So, from now on, it can be removed from the project.

Specified by:

unlock in interface Document