com.screenscraper.model

Class Folder

java.lang.Object

com.screenscraper.model.Folder

All Implemented Interfaces:

Deleteable, java.awt.datatransfer.Transferable, java.lang.Comparable

public class Folder
extends java.lang.Object
implements java.lang.Comparable, Deleteable, java.awt.datatransfer.Transferable

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.awt.datatransfer.DataFlavor[]	flavors
static java.awt.datatransfer.DataFlavor	INFO_FLAVOR
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
Folder(int folderID, java.lang.String name) Generates a folder object with the given name and ID.
Folder(java.lang.String name) Generates a folder object with the given name.

Method Summary

Modifier and Type	Method and Description
void	addChild(java.lang.Object child) Adds a child to the folder.
int	compareTo(java.lang.Object object) Required by the Comparable interface.
void	delete() Deletes this folder from the database.
void	deleteChildren() Deletes all objects found within this folder.
boolean	equals(java.lang.Object object) Overriding equals...
java.lang.Object	getChildObjectBySequence(int sequence) Gets the object corresponding to the sequence.
java.util.Iterator	getChildrenIterator() Provides access to an Iterator allowing the children to be cycled over.
int	getID() Gets the database ID of the folder.
java.lang.String	getName() Gets the name of the folder.
int	getNumChildren() Gets the number of child folders.
Folder	getParentFolder() Gets the parent folder.
static Folder	getRootFolder() Gets the root folder of the tree.
java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor df)
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors()
boolean	hasChildren() Indicates whether or not the folder has child folders.
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor df) Transferable methods.
void	moveChildrenToRootFolder() Moves all child objects to the root folder.
void	removeAllChildren() Clears all children out of the folder.
void	removeChild(java.lang.Object child) Removes a child object from the folder.
void	save() Saves the folder to the database.
void	setName(java.lang.String name) Sets the name of the folder.
void	setParentFolder(Folder parentFolder) Sets the parent folder.
java.lang.String	toString() A string representation of the folder.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

INFO_FLAVOR

public static final java.awt.datatransfer.DataFlavor INFO_FLAVOR

flavors

static java.awt.datatransfer.DataFlavor[] flavors

Constructor Detail

Folder

public Folder(java.lang.String name)

Generates a folder object with the given name.

Parameters:

name - The name of the folder.

Folder

public Folder(int folderID,
              java.lang.String name)

Generates a folder object with the given name and ID.

Parameters:

folderID - The database ID of the folder.

name - The name of the folder.

Method Detail

getID

public int getID()

Gets the database ID of the folder.

Returns:

The database ID.

getName

public java.lang.String getName()

Gets the name of the folder.

Returns:

The name.

setName

public void setName(java.lang.String name)

Sets the name of the folder.

Parameters:

name - The name.

getParentFolder

public Folder getParentFolder()

Gets the parent folder.

Returns:

The parent folder.

setParentFolder

public void setParentFolder(Folder parentFolder)

Sets the parent folder.

Parameters:

parentFolder - The parent folder.

getChildrenIterator

public java.util.Iterator getChildrenIterator()

Provides access to an Iterator allowing the children to be cycled over.

Returns:

The Iterator.

getNumChildren

public int getNumChildren()

Gets the number of child folders.

Returns:

The number.

getChildObjectBySequence

public java.lang.Object getChildObjectBySequence(int sequence)

Gets the object corresponding to the sequence.

Parameters:

sequence - The sequence.

Returns:

The object, if a matching sequence is found.

addChild

public void addChild(java.lang.Object child)

Adds a child to the folder.

Parameters:

child - A ScrapingSession, Script, or Folder.

removeChild

public void removeChild(java.lang.Object child)

Removes a child object from the folder.

Parameters:

child - The child object to remove.

hasChildren

public boolean hasChildren()

Indicates whether or not the folder has child folders.

Returns:

A boolean.

removeAllChildren

public void removeAllChildren()

Clears all children out of the folder.

save

public void save()

Saves the folder to the database.

getRootFolder

public static Folder getRootFolder()

Gets the root folder of the tree.

Returns:

A Folder.

delete

public void delete()

Deletes this folder from the database.

Specified by:

delete in interface Deleteable

moveChildrenToRootFolder

public void moveChildrenToRootFolder()

Moves all child objects to the root folder.

deleteChildren

public void deleteChildren()

Deletes all objects found within this folder.

compareTo

public int compareTo(java.lang.Object object)

Required by the Comparable interface.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

object - The object to compare to.

Returns:

An int indicating how the given object compares to this object.

equals

public boolean equals(java.lang.Object object)

Overriding equals...

Overrides:

equals in class java.lang.Object

Parameters:

object - The object we're comparing.

toString

public java.lang.String toString()

A string representation of the folder.

Overrides:

toString in class java.lang.Object

Returns:

The name of the folder.

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor df)

Transferable methods.

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor df)
                                 throws java.awt.datatransfer.UnsupportedFlavorException,
                                        java.io.IOException

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

Throws:

java.awt.datatransfer.UnsupportedFlavorException

java.io.IOException

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable