|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.ginp.PicCollection
public class PicCollection
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
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 |
---|
public PicCollection(org.dom4j.Element elem)
elem
- Dom4j document element.Method Detail |
---|
public void setPath(java.lang.String s)
s
- The new path value.public void setUserHasWriteAccess(boolean b)
b
- The new userHasWriteAccess valuepublic java.lang.String getName()
public java.lang.String getPath()
public java.lang.String getRoot()
public boolean userHasWriteAccess()
public java.lang.String getDebugDump()
public int getPictureLength()
public java.lang.String getFolder(int count)
count
-
public java.lang.String getPicture(int count)
count
-
public int getFoldersLength()
public java.lang.String getNextPictureName(java.lang.String picName)
picName
-
public java.lang.String getPrevPictureName(java.lang.String picName)
picName
-
public int getPicturesInDirectoryLength(java.lang.String path)
string
-
public java.lang.String[] getPictures()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |