net.sf.ginp
Class PicCollection

java.lang.Object
  extended by net.sf.ginp.PicCollection

public class PicCollection
extends java.lang.Object

This class represents a collection of pictures as configured in the ginp.xml config file. A PicCollection has a root and a files system of folders and pictures. Renamed from Collection because that was too easy to confuse with the java collections class

Version:
$Revision: 303 $
Author:
Doug Culnane

Constructor Summary
PicCollection(org.dom4j.Element elem)
          Constructor for the PicCollection object.
 
Method Summary
 java.lang.String getDebugDump()
          Do a dump of info for debugging
 java.lang.String getFolder(int count)
           
 int getFoldersLength()
           
 java.lang.String getName()
          Gets the name attribute of the PicCollection.
 java.lang.String getNextPictureName(java.lang.String picName)
           
 java.lang.String getPath()
          Gets the path of the collection from its root to the current location.
 java.lang.String getPicture(int count)
           
 int getPictureLength()
           
 java.lang.String[] getPictures()
           
 int getPicturesInDirectoryLength(java.lang.String path)
           
 java.lang.String getPrevPictureName(java.lang.String picName)
           
 java.lang.String getRoot()
          Gets the root attribute of the PicCollection object
 void setPath(java.lang.String s)
          Sets the path attribute of the PicCollection, which idenfifies the current postion in the file system from the PicCollection's root.
 void setUserHasWriteAccess(boolean b)
          Sets the userHasWriteAccess attribute of the PicCollection object
 boolean userHasWriteAccess()
          Description of the Method
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PicCollection

public PicCollection(org.dom4j.Element elem)
Constructor for the PicCollection object. The xml parameter contains the configuration for this PicCollection.

Parameters:
elem - Dom4j document element.
Method Detail

setPath

public void setPath(java.lang.String s)
Sets the path attribute of the PicCollection, which idenfifies the current postion in the file system from the PicCollection's root.

Parameters:
s - The new path value.

setUserHasWriteAccess

public void setUserHasWriteAccess(boolean b)
Sets the userHasWriteAccess attribute of the PicCollection object

Parameters:
b - The new userHasWriteAccess value

getName

public java.lang.String getName()
Gets the name attribute of the PicCollection.

Returns:
The PicCollection name.

getPath

public java.lang.String getPath()
Gets the path of the collection from its root to the current location.

Returns:
The path.

getRoot

public java.lang.String getRoot()
Gets the root attribute of the PicCollection object

Returns:
The root value

userHasWriteAccess

public boolean userHasWriteAccess()
Description of the Method

Returns:
Description of the Return Value

getDebugDump

public java.lang.String getDebugDump()
Do a dump of info for debugging

Returns:
The debugDump value

getPictureLength

public int getPictureLength()
Returns:

getFolder

public java.lang.String getFolder(int count)
Parameters:
count -
Returns:

getPicture

public java.lang.String getPicture(int count)
Parameters:
count -
Returns:

getFoldersLength

public int getFoldersLength()
Returns:

getNextPictureName

public java.lang.String getNextPictureName(java.lang.String picName)
Parameters:
picName -
Returns:

getPrevPictureName

public java.lang.String getPrevPictureName(java.lang.String picName)
Parameters:
picName -
Returns:

getPicturesInDirectoryLength

public int getPicturesInDirectoryLength(java.lang.String path)
Parameters:
string -
Returns:

getPictures

public java.lang.String[] getPictures()
Returns:


Copyright © 2004-2007 null. All Rights Reserved.