org.gvsig.scripting.impl

Class AbstractUnit

java.lang.Object

org.gvsig.scripting.impl.AbstractUnit

All Implemented Interfaces:

Unit, ScriptingUnit

Direct Known Subclasses:

AbstractScript, DefaultScriptingExternalFile, DefaultScriptingFolder

public abstract class AbstractUnit
extends java.lang.Object
implements ScriptingUnit, Unit

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.beans.PropertyChangeListener>	changeListener
protected java.lang.String	createdBy
protected java.lang.String	description
protected java.lang.String	id
protected static Logger	LOGGER
protected DefaultScriptingManager	manager
protected java.lang.String	name
protected ScriptingFolder	parent
protected boolean	saved
protected java.lang.String	typename
protected java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
AbstractUnit(ScriptingFolder parent, java.lang.String typename, ScriptingManager manager, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
protected void	console_println(java.lang.String s)
void	create(ScriptingFolder folder, java.lang.String id)
boolean	equals(java.lang.Object obj)
void	firePropertyChange(java.beans.PropertyChangeEvent event)
void	firePropertyChangeListener(java.lang.String name, java.lang.Object oldValue, java.lang.Object newValue)
java.lang.String	getCreatedBy() Returns information about the ScriptingUnit's creator
java.lang.String	getDescription() Returns the ScriptingUnit's description
java.io.File	getFile() Gets a File with the ScriptUnit path name.
java.io.File	getFileResource(java.lang.String extension)
java.lang.String	getId() Returns the ScriptingUnit's ID
protected boolean	getInfBoolean(Ini prefs, java.lang.String section, java.lang.String option, boolean defaultValue)
protected int	getInfInt(Ini prefs, java.lang.String section, java.lang.String option, int defaultValue)
protected java.lang.String	getInfString(Ini prefs, java.lang.String section, java.lang.String option, java.lang.Object defaultValue)
protected java.lang.Object	getInfValue(Ini prefs, java.lang.String section, java.lang.String option, java.lang.Object defaultValue)
ScriptingManager	getManager()
java.lang.String	getName() Returns the ScriptingUnit's name
ScriptingFolder	getParent() Returns the ScriptingUnit's parent
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getProperty(java.lang.String name)
java.lang.String	getTypeName()
java.net.URL	getURL()
java.lang.String	getUserPath()
java.lang.String	getVersion() Returns the ScriptingUnit's version
int	hashCode()
boolean	isASystemUnit()
boolean	isSaved() Indicates if the ScriptBaseScript is modified from last saved version.
abstract void	load(ScriptingFolder folder, java.lang.String id)
protected void	loadInf(Ini prefs)
void	reload()
protected void	save(Ini prefs)
void	setCreatedBy(java.lang.String createdBy) Sets a new information about the ScriptingUnit's creator.
void	setDescription(java.lang.String description) Sets a new description to the ScriptingUnit.
void	setId(java.lang.String id)
void	setName(java.lang.String name) Sets a new name to the ScriptingUnit.
protected void	setParent(ScriptingFolder parent)
void	setProperty(java.lang.String name, java.lang.String value)
void	setSaved(boolean saved) Sets the unit current status with the saved version.
void	setVersion(java.lang.String version) Sets a new version value to the ScriptingUnit.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gvsig.scripting.impl.Unit

create

Methods inherited from interface org.gvsig.scripting.ScriptingUnit

getFiles, getIconNames, move, remove, rename

Field Detail

LOGGER

protected static final Logger LOGGER

manager

protected DefaultScriptingManager manager

id

protected java.lang.String id

name

protected java.lang.String name

description

protected java.lang.String description

createdBy

protected java.lang.String createdBy

version

protected java.lang.String version

parent

protected ScriptingFolder parent

typename

protected java.lang.String typename

changeListener

protected java.util.Set<java.beans.PropertyChangeListener> changeListener

saved

protected boolean saved

Constructor Detail

AbstractUnit

public AbstractUnit(ScriptingFolder parent,
                    java.lang.String typename,
                    ScriptingManager manager,
                    java.lang.String id)

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface ScriptingUnit

firePropertyChange

public void firePropertyChange(java.beans.PropertyChangeEvent event)

firePropertyChangeListener

public void firePropertyChangeListener(java.lang.String name,
                                       java.lang.Object oldValue,
                                       java.lang.Object newValue)

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface ScriptingUnit

load

public abstract void load(ScriptingFolder folder,
                          java.lang.String id)

Specified by:

load in interface Unit

reload

public void reload()

Specified by:

reload in interface ScriptingUnit

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setParent

protected void setParent(ScriptingFolder parent)

getManager

public ScriptingManager getManager()

getFileResource

public java.io.File getFileResource(java.lang.String extension)

Specified by:

getFileResource in interface ScriptingUnit

getDescription

public java.lang.String getDescription()

Description copied from interface: ScriptingUnit

Returns the ScriptingUnit's description

Specified by:

getDescription in interface ScriptingUnit

Returns:

a String containing the ScriptingUnit's description

getCreatedBy

public java.lang.String getCreatedBy()

Description copied from interface: ScriptingUnit

Returns information about the ScriptingUnit's creator

Specified by:

getCreatedBy in interface ScriptingUnit

Returns:

a String containing the ScriptingUnit's creator

getVersion

public java.lang.String getVersion()

Description copied from interface: ScriptingUnit

Returns the ScriptingUnit's version

Specified by:

getVersion in interface ScriptingUnit

Returns:

a String containing the ScriptingUnit's version

getId

public java.lang.String getId()

Description copied from interface: ScriptingUnit

Returns the ScriptingUnit's ID

Specified by:

getId in interface ScriptingUnit

Returns:

a String containing the ScriptingUnit's ID

getName

public java.lang.String getName()

Description copied from interface: ScriptingUnit

Returns the ScriptingUnit's name

Specified by:

getName in interface ScriptingUnit

Returns:

a String containing the ScriptingUnit's name

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: ScriptingUnit

Sets a new description to the ScriptingUnit.

Specified by:

setDescription in interface ScriptingUnit

Parameters:

description - String that contains the new description.

setCreatedBy

public void setCreatedBy(java.lang.String createdBy)

Description copied from interface: ScriptingUnit

Sets a new information about the ScriptingUnit's creator.

Specified by:

setCreatedBy in interface ScriptingUnit

Parameters:

createdBy - String that contains the new creator's information.

setVersion

public void setVersion(java.lang.String version)

Description copied from interface: ScriptingUnit

Sets a new version value to the ScriptingUnit.

Specified by:

setVersion in interface ScriptingUnit

Parameters:

version - String that contains the new version.

setId

public void setId(java.lang.String id)

Specified by:

setId in interface Unit

setName

public void setName(java.lang.String name)

Description copied from interface: ScriptingUnit

Sets a new name to the ScriptingUnit.

Specified by:

setName in interface ScriptingUnit

Parameters:

name - String that contains the new name.

getParent

public ScriptingFolder getParent()

Description copied from interface: ScriptingUnit

Returns the ScriptingUnit's parent

Specified by:

getParent in interface ScriptingUnit

Returns:

a ScriptingFolder where is contained the ScriptingUnit

getUserPath

public java.lang.String getUserPath()

Specified by:

getUserPath in interface ScriptingUnit

save

protected void save(Ini prefs)

loadInf

protected void loadInf(Ini prefs)

getInfValue

protected java.lang.Object getInfValue(Ini prefs,
                                       java.lang.String section,
                                       java.lang.String option,
                                       java.lang.Object defaultValue)

getInfString

protected java.lang.String getInfString(Ini prefs,
                                        java.lang.String section,
                                        java.lang.String option,
                                        java.lang.Object defaultValue)

getInfInt

protected int getInfInt(Ini prefs,
                        java.lang.String section,
                        java.lang.String option,
                        int defaultValue)

getInfBoolean

protected boolean getInfBoolean(Ini prefs,
                                java.lang.String section,
                                java.lang.String option,
                                boolean defaultValue)

console_println

protected void console_println(java.lang.String s)

create

public void create(ScriptingFolder folder,
                   java.lang.String id)

getFile

public java.io.File getFile()

Description copied from interface: ScriptingUnit

Gets a File with the ScriptUnit path name.

Specified by:

getFile in interface ScriptingUnit

Returns:

a string with the path name of the ScriptUnit (inf/folder).

getURL

public java.net.URL getURL()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isSaved

public boolean isSaved()

Description copied from interface: ScriptingUnit

Indicates if the ScriptBaseScript is modified from last saved version.

Specified by:

isSaved in interface ScriptingUnit

Returns:

true if current version is up-to-date, false if not.

setSaved

public void setSaved(boolean saved)

Description copied from interface: ScriptingUnit

Sets the unit current status with the saved version.

Specified by:

setSaved in interface ScriptingUnit

Parameters:

saved - Indicate if the unit is up-to-date or not.

setProperty

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

Specified by:

setProperty in interface ScriptingUnit

getProperty

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

Specified by:

getProperty in interface ScriptingUnit

getProperties

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

Specified by:

getProperties in interface ScriptingUnit

isASystemUnit

public boolean isASystemUnit()

Specified by:

isASystemUnit in interface ScriptingUnit