at.tuwien.ifs.somtoolbox.properties
Class FileProperties

java.lang.Object
  extended by java.util.Dictionary<K,V>
      extended by java.util.Hashtable<java.lang.Object,java.lang.Object>
          extended by java.util.Properties
              extended by at.tuwien.ifs.somtoolbox.properties.FileProperties
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class FileProperties
extends java.util.Properties

Properties for I/O stuff.

Version:
$Id: FileProperties.java 4248 2012-01-25 10:08:35Z mayer $
Author:
Michael Dittenbach
See Also:
Serialized Form

Field Summary
(package private) static com.martiansoftware.jsap.FlaggedOption[] DATABASE_OPTIONS
           
private  java.lang.String databaseName
           
private  java.lang.String databasePassword
           
private  java.lang.String databaseServerAddress
           
private  java.lang.String databaseTableNamePrefix
           
private  java.lang.String databaseUser
           
(package private) static com.martiansoftware.jsap.FlaggedOption[] FILE_OPTIONS
           
private  boolean isNormalized
           
private  java.lang.String namePrefix
           
private  int numCacheBlocks
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_DB_NAME
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_DB_PASSWORD
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_DB_SERVER
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_DB_TABLE_PREFIX
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_DB_USER
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_INPUT_VECTOR
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_NAME_PREFIX
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_NORMALIZED
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_NUM_CACHE_BLOCKS
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_OUTPUT_DIRECTORY
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_RANDOM_SEED
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_SPARSE_DATA
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_TEMPLATE_VECTOR
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_USE_DB
           
(package private) static com.martiansoftware.jsap.FlaggedOption OPTION_WORKING_DIRECTORY
           
private  java.lang.String outputDirectory
           
private  long randomSeed
           
private static long serialVersionUID
           
private  java.lang.String sourceFileName
           
private  boolean sparseData
           
private  java.lang.String templateFileName
           
private  boolean usingDatabase
           
private  java.lang.String vectorFileName
           
private  java.lang.String workingDirectory
           
 
Fields inherited from class java.util.Properties
defaults
 
Constructor Summary
FileProperties(java.util.Properties properties)
           
FileProperties(java.lang.String fname)
          Loads and encapsulated properties related to the input data.
 
Method Summary
 java.lang.String getDatabaseName()
           
 java.lang.String getDatabasePassword()
           
 java.lang.String getDatabaseServerAddress()
           
 java.lang.String getDatabaseTableNamePrefix()
           
 java.lang.String getDatabaseUser()
           
 boolean isNormalized()
          Returns true, if the vectors are normalized to unit length.
 boolean isUsingDatabase()
           
 java.lang.String namePrefix(boolean withPrefix)
          Returns the name of the test run.
 int numCacheBlocks()
          Not used at the moment.
 java.lang.String outputDirectory()
          Returns the name of the output directory.
private  void parse()
           
private  java.lang.String prependDirectory(boolean withPrefix, java.lang.String path, java.lang.String dir)
           
private  java.lang.String prependDirectory(java.lang.String path, java.lang.String dir)
           
 long randomSeed()
          Returns the random seed.
 void setUsingDatabase(boolean usedatabase)
           
 boolean sparseData()
          Returns true if the input data vectors are sparsely populated.
 java.lang.String templateFileName(boolean withPrefix)
          Returns the name of the template vector file.
 java.lang.String vectorFileName(boolean withPrefix)
          Returns the name of the input vector file.
 java.lang.String workingDirectory()
          Returns the name of the working directory.
 
Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames
 
Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

OPTION_WORKING_DIRECTORY

static final com.martiansoftware.jsap.FlaggedOption OPTION_WORKING_DIRECTORY

OPTION_OUTPUT_DIRECTORY

static final com.martiansoftware.jsap.FlaggedOption OPTION_OUTPUT_DIRECTORY

OPTION_NAME_PREFIX

static final com.martiansoftware.jsap.FlaggedOption OPTION_NAME_PREFIX

OPTION_INPUT_VECTOR

static final com.martiansoftware.jsap.FlaggedOption OPTION_INPUT_VECTOR

OPTION_TEMPLATE_VECTOR

static final com.martiansoftware.jsap.FlaggedOption OPTION_TEMPLATE_VECTOR

OPTION_SPARSE_DATA

static final com.martiansoftware.jsap.FlaggedOption OPTION_SPARSE_DATA

OPTION_NORMALIZED

static final com.martiansoftware.jsap.FlaggedOption OPTION_NORMALIZED

OPTION_RANDOM_SEED

static final com.martiansoftware.jsap.FlaggedOption OPTION_RANDOM_SEED

OPTION_NUM_CACHE_BLOCKS

static final com.martiansoftware.jsap.FlaggedOption OPTION_NUM_CACHE_BLOCKS

OPTION_USE_DB

static final com.martiansoftware.jsap.FlaggedOption OPTION_USE_DB

OPTION_DB_SERVER

static final com.martiansoftware.jsap.FlaggedOption OPTION_DB_SERVER

OPTION_DB_NAME

static final com.martiansoftware.jsap.FlaggedOption OPTION_DB_NAME

OPTION_DB_USER

static final com.martiansoftware.jsap.FlaggedOption OPTION_DB_USER

OPTION_DB_PASSWORD

static final com.martiansoftware.jsap.FlaggedOption OPTION_DB_PASSWORD

OPTION_DB_TABLE_PREFIX

static final com.martiansoftware.jsap.FlaggedOption OPTION_DB_TABLE_PREFIX

FILE_OPTIONS

static final com.martiansoftware.jsap.FlaggedOption[] FILE_OPTIONS

DATABASE_OPTIONS

static final com.martiansoftware.jsap.FlaggedOption[] DATABASE_OPTIONS

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

isNormalized

private boolean isNormalized

namePrefix

private java.lang.String namePrefix

numCacheBlocks

private int numCacheBlocks

outputDirectory

private java.lang.String outputDirectory

randomSeed

private long randomSeed

sparseData

private boolean sparseData

templateFileName

private java.lang.String templateFileName

vectorFileName

private java.lang.String vectorFileName

workingDirectory

private java.lang.String workingDirectory

usingDatabase

private boolean usingDatabase

databaseServerAddress

private java.lang.String databaseServerAddress

databaseName

private java.lang.String databaseName

databaseUser

private java.lang.String databaseUser

databasePassword

private java.lang.String databasePassword

databaseTableNamePrefix

private java.lang.String databaseTableNamePrefix

sourceFileName

private java.lang.String sourceFileName
Constructor Detail

FileProperties

public FileProperties(java.lang.String fname)
               throws PropertiesException
Loads and encapsulated properties related to the input data.

Parameters:
fname - Name of the properties file.
Throws:
PropertiesException

FileProperties

public FileProperties(java.util.Properties properties)
               throws PropertiesException
Throws:
PropertiesException
Method Detail

parse

private void parse()
            throws PropertiesException
Throws:
PropertiesException

isNormalized

public boolean isNormalized()
Returns true, if the vectors are normalized to unit length. This information is used for map creation to know when to normalize the units' weight vectors.

Returns:
Returns true, if the vectors are normalized to unit length.

namePrefix

public java.lang.String namePrefix(boolean withPrefix)
Returns the name of the test run.

Returns:
the name of the test run.

numCacheBlocks

public int numCacheBlocks()
Not used at the moment.

Returns:
Returns the numCacheBlocks.

outputDirectory

public java.lang.String outputDirectory()
Returns the name of the output directory.

Returns:
the name of the output directory.

randomSeed

public long randomSeed()
Returns the random seed.

Returns:
the random seed.

sparseData

public boolean sparseData()
Returns true if the input data vectors are sparsely populated.

Returns:
true if the input data vectors are sparsely populated.

templateFileName

public java.lang.String templateFileName(boolean withPrefix)
Returns the name of the template vector file. The file name includes the working directory, if argument withPrefix is true.

Parameters:
withPrefix - determines if the file name is prefixed with the working directory.
Returns:
the name of the template vector file.

prependDirectory

private java.lang.String prependDirectory(boolean withPrefix,
                                          java.lang.String path,
                                          java.lang.String dir)

prependDirectory

private java.lang.String prependDirectory(java.lang.String path,
                                          java.lang.String dir)

vectorFileName

public java.lang.String vectorFileName(boolean withPrefix)
Returns the name of the input vector file. The file name includes the working directory, if argument withPrefix is true.

Parameters:
withPrefix - determines if the file name is prefixed with the working directory.
Returns:
the name of the input vector file.

workingDirectory

public java.lang.String workingDirectory()
Returns the name of the working directory.

Returns:
the name of the working directory.

isUsingDatabase

public boolean isUsingDatabase()

setUsingDatabase

public void setUsingDatabase(boolean usedatabase)

getDatabaseName

public java.lang.String getDatabaseName()

getDatabasePassword

public java.lang.String getDatabasePassword()

getDatabaseServerAddress

public java.lang.String getDatabaseServerAddress()

getDatabaseUser

public java.lang.String getDatabaseUser()

getDatabaseTableNamePrefix

public java.lang.String getDatabaseTableNamePrefix()