org.gvsig.scripting.impl

Class DefaultScriptingFolder

java.lang.Object

org.gvsig.scripting.impl.AbstractUnit

org.gvsig.scripting.impl.DefaultScriptingFolder

All Implemented Interfaces:

Unit, ScriptingFolder, ScriptingUnit, Visitable

Direct Known Subclasses:

SystemFolder, UserFolder

public class DefaultScriptingFolder
extends AbstractUnit
implements ScriptingFolder

Field Summary

Fields

Modifier and Type	Field and Description
protected File	folder

Fields inherited from class org.gvsig.scripting.impl.AbstractUnit

changeListener, createdBy, description, id, manager, name, parent, saved, typename, version

Constructor Summary

Constructors

Constructor and Description
DefaultScriptingFolder(ScriptingFolder parent, ScriptingManager manager)
DefaultScriptingFolder(ScriptingFolder parent, ScriptingManager manager, File folder)
DefaultScriptingFolder(ScriptingFolder parent, ScriptingManager manager, URL folder)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Provides each value of this container to the provided Visitor.
void	add(ScriptingUnit unit) Adds a ScriptingUnit to the ScriptingFolder.
void	create(ScriptingFolder folder, String id)
void	create(ScriptingFolder folder, String id, String language)
File	getFile() Gets a File with the ScriptUnit path name.
List<File>	getFiles() Return a list of the files that use this unit with out the inf file.
String[]	getIconNames() Gets the name of the icons associated to the ScriptingUnit type.
ScriptingFolder	getParent() Returns the ScriptingUnit's parent
Unit	getUnit(File afile) Returns the ScriptingUnit associated with a File.
List<ScriptingFolder>	getUnitFolders()
List<ScriptingUnit>	getUnits() Gets all the ScriptingUnits contained in a ScriptingFolder.
void	load(ScriptingFolder folder, String id)
boolean	move(ScriptingFolder target) Moves a ScriptingUnitfrom the current directory to the new location.
boolean	remove()
void	remove(ScriptingUnit unit) Removes a ScriptingUnit from the ScriptingFolder.
boolean	rename(String newId) Changes the ID of a ScriptingUnit and the name of the files and/or directories associated

Methods inherited from class org.gvsig.scripting.impl.AbstractUnit

addPropertyChangeListener, console_println, firePropertyChange, firePropertyChangeListener, getCreatedBy, getDescription, getFileResource, getId, getInfBoolean, getInfInt, getInfString, getInfValue, getManager, getName, getTypeName, getVersion, isSaved, loadInf, save, setCreatedBy, setDescription, setId, setName, setParent, setSaved, setVersion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.scripting.ScriptingUnit

addPropertyChangeListener, getCreatedBy, getDescription, getId, getName, getTypeName, getVersion, isSaved, setCreatedBy, setDescription, setName, setSaved, setVersion

Field Detail

folder

protected File folder

Constructor Detail

DefaultScriptingFolder

public DefaultScriptingFolder(ScriptingFolder parent,
                      ScriptingManager manager)

DefaultScriptingFolder

public DefaultScriptingFolder(ScriptingFolder parent,
                      ScriptingManager manager,
                      File folder)

DefaultScriptingFolder

public DefaultScriptingFolder(ScriptingFolder parent,
                      ScriptingManager manager,
                      URL folder)

Method Detail

create

public void create(ScriptingFolder folder,
          String id)

Overrides:

create in class AbstractUnit

getFile

public File getFile()

Description copied from interface: ScriptingUnit

Gets a File with the ScriptUnit path name.

Specified by:

getFile in interface ScriptingUnit

Overrides:

getFile in class AbstractUnit

Returns:

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

getFiles

public List<File> getFiles()

Description copied from interface: ScriptingUnit

Return a list of the files that use this unit with out the inf file.

Specified by:

getFiles in interface ScriptingUnit

Returns:

list of files of the unit.

getParent

public ScriptingFolder getParent()

Description copied from interface: ScriptingUnit

Returns the ScriptingUnit's parent

Specified by:

getParent in interface ScriptingUnit

Overrides:

getParent in class AbstractUnit

Returns:

a ScriptingFolder where is contained the ScriptingUnit

getUnit

public Unit getUnit(File afile)

Description copied from interface: ScriptingFolder

Returns the ScriptingUnit associated with a File.

Specified by:

getUnit in interface ScriptingFolder

Parameters:

afile - File of the data origin.

Returns:

a ScriptingUnit with the content extracted from the file.

getUnits

public List<ScriptingUnit> getUnits()

Description copied from interface: ScriptingFolder

Gets all the ScriptingUnits contained in a ScriptingFolder.

Specified by:

getUnits in interface ScriptingFolder

Returns:

a List with the ScriptingUnits.

getUnitFolders

public List<ScriptingFolder> getUnitFolders()

Specified by:

getUnitFolders in interface ScriptingFolder

add

public void add(ScriptingUnit unit)

Description copied from interface: ScriptingFolder

Adds a ScriptingUnit to the ScriptingFolder.

Specified by:

add in interface ScriptingFolder

Parameters:

unit - ScriptingUnit to include.

remove

public void remove(ScriptingUnit unit)

Description copied from interface: ScriptingFolder

Removes a ScriptingUnit from the ScriptingFolder.

Specified by:

remove in interface ScriptingFolder

Parameters:

unit - ScriptingUnit to delete.

load

public void load(ScriptingFolder folder,
        String id)

Specified by:

load in interface Unit

Specified by:

load in class AbstractUnit

getIconNames

public String[] getIconNames()

Description copied from interface: ScriptingUnit

Gets the name of the icons associated to the ScriptingUnit type.

Specified by:

getIconNames in interface ScriptingUnit

Returns:

a String array with the identificators of the icons associated.

remove

public boolean remove()

Specified by:

remove in interface ScriptingUnit

create

public void create(ScriptingFolder folder,
          String id,
          String language)

Specified by:

create in interface Unit

move

public boolean move(ScriptingFolder target)

Description copied from interface: ScriptingUnit

Moves a ScriptingUnitfrom the current directory to the new location.

Specified by:

move in interface ScriptingUnit

Parameters:

target - ScriptingFolder that represents the destination..

Returns:

true if it's succesful, false if not.

rename

public boolean rename(String newId)

Description copied from interface: ScriptingUnit

Changes the ID of a ScriptingUnit and the name of the files and/or directories associated

Specified by:

rename in interface ScriptingUnit

Parameters:

newId - String that contains the new Id.

Returns:

true if it's succesful, false if not.

accept

public void accept(Visitor visitor)
            throws BaseException

Description copied from interface: Visitable

Provides each value of this container to the provided Visitor.

Specified by:

accept in interface Visitable

Parameters:

visitor - the visitor to apply to each value.

Throws:

BaseException - if there is an error while performing the visit