com.highqsoft.ods

Class OdsFilenameURL

java.lang.Object

com.highqsoft.ods.OdsFilenameURL

public class OdsFilenameURL
extends java.lang.Object

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

Since:

$Date: 2018/04/05 12:31:48 $

Version:

$Revision: 1.30 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected AoSession	aoSess
protected static java.lang.String	BinPath
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 java.util.HashMap<java.lang.String,java.lang.String>	symbolMap

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.
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.io.File file, java.util.logging.Logger messenger) 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.
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.

Methods inherited from class java.lang.Object

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

Field Detail

FileRootName

protected static java.lang.String FileRootName

FileRootExtRefName

protected static java.lang.String FileRootExtRefName

FileSymbols

protected static java.lang.String FileSymbols

BinPath

protected static java.lang.String BinPath

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

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)

Method Detail

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)

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

Parameters:

symbol - the symbol

Returns:

the value

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

getStorageLocation

public java.lang.String getStorageLocation(java.io.File file,
                                  java.util.logging.Logger messenger)
                                    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

messenger - messenger for debugging output

Returns:

the storage location.

Throws:

AoException - any occurring ASAM ODS exception.

java.io.IOException

getFile

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

Get the file from the storage location.

Parameters:

storageLocation - the storage location

Returns:

the File

Throws:

AoException - any occurring ASAM ODS exception