Package com.appliedolap.essbase.impl

Class EssFolderImpl

java.lang.Object

com.appliedolap.essbase.AbstractEssObject

com.appliedolap.essbase.impl.EssFileImpl

com.appliedolap.essbase.impl.EssFolderImpl

All Implemented Interfaces:

EssFile, EssFolder, EssObject

public class EssFolderImpl
extends EssFileImpl
implements EssFolder

Represents a folder in the remote Essbase server pseudo-filesystem.

Nested Class Summary

Nested classes/interfaces inherited from interface com.appliedolap.essbase.EssObject

EssObject.Type

Field Summary

Fields inherited from class com.appliedolap.essbase.impl.EssFileImpl

fullPath

Fields inherited from class com.appliedolap.essbase.AbstractEssObject

api

Constructor Summary

Constructors

Constructor	Description
EssFolderImpl(ApiContext api, EssServer server, String name, String fullPath)

Method Summary

Modifier and Type	Method	Description
void	createSubFolder(String subFolderName)	Creates a subfolder in this folder.
List<EssFile>	getFiles()	Lists this folder's contents.
boolean	isFile()	Returns true if this is a file, not a folder.
boolean	isFolder()	Checks if this file object represents a file or a folder.
void	uploadFile(File file)	Uploads a file to this folder.

Methods inherited from class com.appliedolap.essbase.impl.EssFileImpl

copy, delete, download, downloadTo, downloadToFolder, extract, getDatabasesInLcmZip, getFullPath, getName, getPath, getServer, getType, lcmImport, move, rename

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.appliedolap.essbase.EssFile

copy, delete, download, downloadTo, downloadToFolder, extract, getDatabasesInLcmZip, getFullPath, getName, getPath, getServer, getType, lcmImport, move, rename

Constructor Details

EssFolderImpl

public EssFolderImpl(ApiContext api,
 EssServer server,
 String name,
 String fullPath)

Method Details

isFolder

public boolean isFolder()

Description copied from interface: EssFile

Checks if this file object represents a file or a folder. If this method returns true, then this class may be cast to EssFolderImpl, which is a subclass of this one.

Specified by:

isFolder in interface EssFile

Specified by:

isFolder in interface EssFolder

Overrides:

isFolder in class EssFileImpl

Returns:

true if this object represents a folder, false otherwise

isFile

public boolean isFile()

Description copied from interface: EssFile

Returns true if this is a file, not a folder.

Specified by:

isFile in interface EssFile

Specified by:

isFile in interface EssFolder

Overrides:

isFile in class EssFileImpl

Returns:

true if this object is a file

createSubFolder

public void createSubFolder(String subFolderName)

Description copied from interface: EssFolder

Creates a subfolder in this folder.

Specified by:

createSubFolder in interface EssFolder

Parameters:

subFolderName - the name of the subfolder

uploadFile

public void uploadFile(File file)

Description copied from interface: EssFolder

Uploads a file to this folder.

Specified by:

uploadFile in interface EssFolder

Parameters:

file - the file

getFiles

public List<EssFile> getFiles()

Lists this folder's contents.

Goes through NativeHttp rather than the generated client, for the same reason uploadFile(java.io.File) and createSubFolder(java.lang.String) already do: the generated call puts the whole path through urlEncode, which escapes the separators too, so anything below the top level is asked for as /files/applications%2FSample and the server answers Specified path '/applications%2FSample' does not exist. Every folder but the roots was unbrowsable.

Specified by:

getFiles in interface EssFolder