com.highqsoft.corbafileserver

Class OdsFilenameURL

java.lang.Object

com.highqsoft.corbafileserver.OdsFilenameURL

public class OdsFilenameURL
extends java.lang.Object

Class handling the ODS Filename with URL depending from the filemode, filenotation and fileroot.

Since:

$Date: 2019/08/15 09:23:16 $

Version:

$Revision: 1.27 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected AoSession	aoSess
protected static java.lang.String	BinPath
protected static boolean	checkPath
protected static java.lang.String	FileRootExtRefName
protected java.lang.String	fileRootName
protected static java.lang.String	FileRootName
protected static java.lang.String	FileSymbols
protected OdsFileMode	fm
protected OdsFileNotation	fn
protected static java.util.HashMap<java.lang.Integer,OdsFilenameURL>	OdsFileUrlMap
protected java.util.HashMap<java.lang.String,java.lang.String>	symbolMap
protected java.lang.String	uriPrefix
protected static boolean	useCache

Constructor Summary

Constructors

Constructor and Description
OdsFilenameURL(AoSession aoSess) Constructor, use the session for the setting of Avalon.
OdsFilenameURL(AoSession aoSess, java.lang.String fileRootName) Constructor, use the session for the setting of Avalon.

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	getFile(java.lang.String storageLocation) Get the file from the storage location.
protected java.io.File	getFileInternal(java.lang.String storageLocation) Get the file from the storage location without the check.
java.lang.String	getFormatDate(java.lang.String format) This method returns the current date as a string.
static OdsFilenameURL	getInstances(AoSession aoSess, java.lang.String fileRoot)
java.lang.String	getStorageLocation(java.io.File file) Get the string of the storage location, this string can be used to store the in the filename_url attribute of the AoExternalComponent
java.lang.String	getStorageLocation(java.lang.String filename) Get the string of the storage location, this string can be used to store the in the filename_url attribute of the AoExternalComponent
protected java.lang.String	getSymbol(java.lang.String symbol) Get the symbol, use the map as cache for the symbols of the session.
static void	setCheckPath(boolean check) Set the switch to check the path, to be the directory or sub directory of one of the symbols.
void	setFileRootName(java.lang.String fileRootName) Set the name of the FILE_ROOT, the default is FILE_ROOT for external reference use FILE_ROOT_EXTREF.
void	setUriPrefix(java.lang.String uriPrefix) Set the URI prefix, e.g file:
static void	setUsecache(boolean use) Set the switch to use cache of the session.
protected java.lang.String	substituteSymbol(java.lang.String key) Substitute the symbol of the key.

Methods inherited from class java.lang.Object

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

Field Detail

FileRootName

protected static final java.lang.String FileRootName

See Also:

Constant Field Values

FileRootExtRefName

protected static final java.lang.String FileRootExtRefName

See Also:

Constant Field Values

FileSymbols

protected static final java.lang.String FileSymbols

See Also:

Constant Field Values

BinPath

protected static final java.lang.String BinPath

See Also:

Constant Field Values

uriPrefix

protected java.lang.String uriPrefix

aoSess

protected AoSession aoSess

fm

protected OdsFileMode fm

fn

protected OdsFileNotation fn

symbolMap

protected java.util.HashMap<java.lang.String,java.lang.String> symbolMap

fileRootName

protected java.lang.String fileRootName

useCache

protected static boolean useCache

OdsFileUrlMap

protected static java.util.HashMap<java.lang.Integer,OdsFilenameURL> OdsFileUrlMap

checkPath

protected static boolean checkPath

Constructor Detail

OdsFilenameURL

public OdsFilenameURL(AoSession aoSess)

Constructor, use the session for the setting of Avalon.

Parameters:

aoSess - the session for the settings.

OdsFilenameURL

public OdsFilenameURL(AoSession aoSess,
              java.lang.String fileRootName)

Constructor, use the session for the setting of Avalon.

Parameters:

aoSess - the session for the settings.

fileRootName - the symbol of the file root (FILE_ROOT or FILE_ROOT_EXTREF), in case of null will be set to FileRootName

Method Detail

getInstances

public static OdsFilenameURL getInstances(AoSession aoSess,
                          java.lang.String fileRoot)

setUsecache

public static void setUsecache(boolean use)

Set the switch to use cache of the session.

Parameters:

use -

setFileRootName

public void setFileRootName(java.lang.String fileRootName)

Set the name of the FILE_ROOT, the default is FILE_ROOT for external reference use FILE_ROOT_EXTREF.

Parameters:

fileRootName - the file root name.

getSymbol

protected java.lang.String getSymbol(java.lang.String symbol)
                              throws AoException

Get the symbol, use the map as cache for the symbols of the session.

Parameters:

symbol - the symbol

Returns:

the value

Throws:

AoException

substituteSymbol

protected java.lang.String substituteSymbol(java.lang.String key)
                                     throws AoException

Substitute the symbol of the key.

Parameters:

key - the key with symbol

Returns:

the substituted key.

Throws:

AoException - any occurring ASAM ODS Exception

getStorageLocation

public java.lang.String getStorageLocation(java.lang.String filename)
                                    throws AoException

Get the string of the storage location, this string can be used to store the in the filename_url attribute of the AoExternalComponent

Parameters:

filename - the filename

Returns:

the storage location.

Throws:

AoException - any occurring ASAM ODS exception.

getStorageLocation

public java.lang.String getStorageLocation(java.io.File file)
                                    throws AoException,
                                           java.io.IOException

Get the string of the storage location, this string can be used to store the in the filename_url attribute of the AoExternalComponent

Parameters:

file - the file

Returns:

the storage location.

Throws:

AoException - any occurring ASAM ODS exception.

java.io.IOException

getFormatDate

public java.lang.String getFormatDate(java.lang.String format)

This method returns the current date as a string. The format of the date can be given in the format string. The default format is "YYYYMMDD".

Parameters:

format - the format of the date.

Returns:

the date string.

getFile

public java.io.File getFile(java.lang.String storageLocation)
                     throws AoException,
                            CORBAFileServerException

Get the file from the storage location.

Parameters:

storageLocation - the storage location

Returns:

the File

Throws:

AoException

CORBAFileServerException

getFileInternal

protected java.io.File getFileInternal(java.lang.String storageLocation)
                                throws AoException

Get the file from the storage location without the check.

Parameters:

storageLocation - the storage location

Returns:

the File

Throws:

AoException

CORBAFileServerException

setUriPrefix

public void setUriPrefix(java.lang.String uriPrefix)

Set the URI prefix, e.g file:

Parameters:

uriPrefix - the uri prefix

setCheckPath

public static void setCheckPath(boolean check)

Set the switch to check the path, to be the directory or sub directory of one of the symbols.

Parameters:

check - true the check will be done.