org.openmuc.framework.datalogger.ascii.utils

Class LoggerUtils

java.lang.Object

org.openmuc.framework.datalogger.ascii.utils.LoggerUtils

public class LoggerUtils
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	addSpaces(int length, int size, java.lang.StringBuilder sb) This method adds a blank spaces to a StringBuilder object.
static void	appendSpaces(java.lang.StringBuilder sb, int number) This method adds a string value up with blank spaces from left to right.
static java.util.Map<java.lang.String,java.lang.Boolean>	areHeadersIdentical(java.lang.String loggerDirectory, java.util.List<org.openmuc.framework.datalogger.spi.LogChannel> channels, java.util.Calendar calendar)
static void	buildError(java.lang.StringBuilder sbValue, org.openmuc.framework.data.Flag flag) Construct a error value with standard error prefix and the flag as number.
static java.lang.String	buildFilename(int loggingInterval, int logTimeOffset, java.util.Calendar calendar) Builds the Logfile name from logging interval, logging time offset and the date of the calendar
static java.lang.String	buildFilename(java.lang.String intervalTimeOffset, java.util.Calendar calendar) Builds the Logfile name from string interval_timeOffset and the date of the calendar
static void	byteArrayToHexString(java.lang.StringBuilder sb, byte[] byteArray) Converts a byte array to an hexadecimal string
static long	fillUp(java.io.PrintWriter out, long unixTimeStamp, long loggingInterval, long numberOfFillUpLines, java.lang.StringBuilder errorValues) * fills a AsciiLogg file up.
static java.util.Calendar	getCalendarTodayZero(java.util.Calendar today) Returns the calendar from today with the first hour, minute, second and millisecond.
static int	getColumnNumberByName(java.lang.String line, java.lang.String name) Get the column number by name.
static java.util.Map<java.lang.String,java.lang.Integer>	getColumnNumbersByNames(java.lang.String line, java.lang.String[] names) Get the columns number by names.
static int	getCommentColumnNumberByName(java.lang.String name, java.io.BufferedReader br) Get the column number by name, in comments.
static java.lang.String	getCommentValue(int colNumber, int column, java.io.BufferedReader br) Get the value which is coded in the comment
static java.lang.StringBuilder	getErrorValues(java.lang.String[] lineArray) Returns the error value as a StringBuilder.
static java.lang.String	getFilename(int loggingInterval, int logTimeOffset, long timestamp) Returns the filename, with the help of the timestamp and the interval.
static java.util.List<java.lang.String>	getFilenames(int loggingInterval, int logTimeOffset, long startTimestamp, long endTimestamp) Returns all filenames of the given time span defined by the two dates
static java.lang.String	getHeaderFromFile(java.lang.String filePath)
static int	getLengthOfValueType(org.openmuc.framework.data.ValueType valueType) Returns the predefined size of a ValueType.
static long	getNumberOfFillUpLines(long lastUnixTimeStamp, long loggingInterval)
static java.io.PrintWriter	getPrintWriter(java.io.File file, boolean append)
static java.io.RandomAccessFile	getRandomAccessFile(java.io.File file, java.lang.String accesMode) Returns a RandomAccessFile of the specified file.
static int	getValueTypeLengthFromFile(int columnNumber, java.io.File dataFile)
static boolean	hasNext(java.util.List<org.openmuc.framework.datalogger.spi.LoggingRecord> containers, int i) Checks if it has a next container entry.
static org.openmuc.framework.data.ValueType	identifyValueType(int columnNumber, java.io.File dataFile) Identifies the ValueType of a logger value on a specific col_no
static void	renameAllFilesToOld(java.lang.String directoryPath, java.util.Calendar calendar) This method rename all *.dat files with the date from today in directoryPath into a *.old0, *.old1, ...
static void	renameFileToOld(java.lang.String directoryPath, java.lang.String loggerIntervalLoggerTimeOffset, java.util.Calendar calendar) This method renames a singel <date>_<loggerInterval>_<loggerTimeOffset>.dat file into a *.old0, *.old1, ...
static void	setLoggerTimestamps(java.lang.StringBuilder sb, java.util.Calendar calendar) Constructs the timestamp for every log value into a StringBuilder.
static void	setLoggerTimestamps(java.lang.StringBuilder sb, long unixTimeStamp) Constructs the timestamp for every log value into a StringBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

getFilenames

public static java.util.List<java.lang.String> getFilenames(int loggingInterval,
                                                            int logTimeOffset,
                                                            long startTimestamp,
                                                            long endTimestamp)

Returns all filenames of the given time span defined by the two dates

Parameters:

loggingInterval - logging interval

logTimeOffset - logging time offset

startTimestamp - start time stamp

endTimestamp - end time stamp

Returns:

a list of strings with all files names

getFilename

public static java.lang.String getFilename(int loggingInterval,
                                           int logTimeOffset,
                                           long timestamp)

Returns the filename, with the help of the timestamp and the interval.

Parameters:

loggingInterval - logging interval

logTimeOffset - logging time offset

timestamp - timestamp

Returns:

a filename from timestamp (date) and interval

buildFilename

public static java.lang.String buildFilename(int loggingInterval,
                                             int logTimeOffset,
                                             java.util.Calendar calendar)

Builds the Logfile name from logging interval, logging time offset and the date of the calendar

Parameters:

loggingInterval - logging interval

logTimeOffset - logging time offset

calendar - Calendar for the time of the file name

Returns:

logging file name

buildFilename

public static java.lang.String buildFilename(java.lang.String intervalTimeOffset,
                                             java.util.Calendar calendar)

Builds the Logfile name from string interval_timeOffset and the date of the calendar

Parameters:

intervalTimeOffset - the IntervallTimeOffset

calendar - Calendar for the time of the file name

Returns:

logfile name

hasNext

public static boolean hasNext(java.util.List<org.openmuc.framework.datalogger.spi.LoggingRecord> containers,
                              int i)

Checks if it has a next container entry.

Parameters:

containers - a list with LogRecordContainer

i - the current possition of the list

Returns:

true if it has a next container entry, if not else.

renameAllFilesToOld

public static void renameAllFilesToOld(java.lang.String directoryPath,
                                       java.util.Calendar calendar)

This method rename all *.dat files with the date from today in directoryPath into a *.old0, *.old1, ...

Parameters:

directoryPath - directory path

calendar - Calendar for the time of the file name

renameFileToOld

public static void renameFileToOld(java.lang.String directoryPath,
                                   java.lang.String loggerIntervalLoggerTimeOffset,
                                   java.util.Calendar calendar)

This method renames a singel <date>_<loggerInterval>_<loggerTimeOffset>.dat file into a *.old0, *.old1, ...

Parameters:

directoryPath - directory path

loggerIntervalLoggerTimeOffset - logger interval with logger time offset as String separated with underline

calendar - calendar of the day

getCalendarTodayZero

public static java.util.Calendar getCalendarTodayZero(java.util.Calendar today)

Returns the calendar from today with the first hour, minute, second and millisecond.

Parameters:

today - the current calendar

Returns:

the calendar from today with the first hour, minute, second and millisecond

addSpaces

public static void addSpaces(int length,
                             int size,
                             java.lang.StringBuilder sb)

This method adds a blank spaces to a StringBuilder object.

Parameters:

length - length of the value to add the spaces

size - maximal allowed size

sb - StringBuilder object to add the spaces

appendSpaces

public static void appendSpaces(java.lang.StringBuilder sb,
                                int number)

This method adds a string value up with blank spaces from left to right.

Parameters:

sb - StringBuilder in wich the spaces will appended

number - the number of spaces

buildError

public static void buildError(java.lang.StringBuilder sbValue,
                              org.openmuc.framework.data.Flag flag)

Construct a error value with standard error prefix and the flag as number.

Parameters:

flag - the wished error flag

sbValue - string buffer to add the error flag

getColumnNumberByName

public static int getColumnNumberByName(java.lang.String line,
                                        java.lang.String name)

Get the column number by name.

Parameters:

line - the line to search

name - the name to search in line

Returns:

the column number as int.

getColumnNumbersByNames

public static java.util.Map<java.lang.String,java.lang.Integer> getColumnNumbersByNames(java.lang.String line,
                                                                                        java.lang.String[] names)

Get the columns number by names.

Parameters:

line - the line to search

names - the name to search in line

Returns:

the column numbers mapped with the name.

getCommentColumnNumberByName

public static int getCommentColumnNumberByName(java.lang.String name,
                                               java.io.BufferedReader br)
                                        throws java.io.IOException

Get the column number by name, in comments. It searches the line by his self. The BufferdReader has to be on the begin of the file.

Parameters:

name - the name to search

br - the BufferedReader

Returns:

column number as int, -1 if name not found

Throws:

java.io.IOException - throws IOException If an I/O error occurs

getCommentValue

public static java.lang.String getCommentValue(int colNumber,
                                               int column,
                                               java.io.BufferedReader br)
                                        throws java.io.IOException

Get the value which is coded in the comment

Parameters:

colNumber - the number of the channel

column - the column

br - a BufferedReader

Returns:

the value of a column of a specific col_num

Throws:

java.io.IOException - If an I/O error occurs

identifyValueType

public static org.openmuc.framework.data.ValueType identifyValueType(int columnNumber,
                                                                     java.io.File dataFile)

Identifies the ValueType of a logger value on a specific col_no

Parameters:

columnNumber - column number

dataFile - the logger data file

Returns:

the ValueType from col_num x

getValueTypeLengthFromFile

public static int getValueTypeLengthFromFile(int columnNumber,
                                             java.io.File dataFile)

getLengthOfValueType

public static int getLengthOfValueType(org.openmuc.framework.data.ValueType valueType)

Returns the predefined size of a ValueType.

Parameters:

valueType - the type to get the predefined size

Returns:

predefined size of a ValueType as int.

byteArrayToHexString

public static void byteArrayToHexString(java.lang.StringBuilder sb,
                                        byte[] byteArray)

Converts a byte array to an hexadecimal string

Parameters:

sb - to add hex string

byteArray - the byte array to convert

setLoggerTimestamps

public static void setLoggerTimestamps(java.lang.StringBuilder sb,
                                       java.util.Calendar calendar)

Constructs the timestamp for every log value into a StringBuilder.

Parameters:

sb - the StringBuilder to add the logger timestamp

calendar - Calendar with the wished time

setLoggerTimestamps

public static void setLoggerTimestamps(java.lang.StringBuilder sb,
                                       long unixTimeStamp)

Constructs the timestamp for every log value into a StringBuilder.

Parameters:

sb - the StringBuilder to add the logger timestamp

unixTimeStamp - unix time stamp in ms

getHeaderFromFile

public static java.lang.String getHeaderFromFile(java.lang.String filePath)

getRandomAccessFile

public static java.io.RandomAccessFile getRandomAccessFile(java.io.File file,
                                                           java.lang.String accesMode)

Returns a RandomAccessFile of the specified file.

Parameters:

file - file get the RandomAccessFile

accesMode - access mode

Returns:

the RandomAccessFile of the specified file, null if an error occured.

getPrintWriter

public static java.io.PrintWriter getPrintWriter(java.io.File file,
                                                 boolean append)
                                          throws java.io.IOException

Throws:

java.io.IOException

areHeadersIdentical

public static java.util.Map<java.lang.String,java.lang.Boolean> areHeadersIdentical(java.lang.String loggerDirectory,
                                                                                    java.util.List<org.openmuc.framework.datalogger.spi.LogChannel> channels,
                                                                                    java.util.Calendar calendar)

fillUp

public static long fillUp(java.io.PrintWriter out,
                          long unixTimeStamp,
                          long loggingInterval,
                          long numberOfFillUpLines,
                          java.lang.StringBuilder errorValues)

* fills a AsciiLogg file up.

Parameters:

out - the output stream to write on

unixTimeStamp - unix time stamp

loggingInterval - logging interval

numberOfFillUpLines - the number to fill up lines

errorValues - the error value set in the line

Returns:

returns the unix time stamp of the last filled up line

getNumberOfFillUpLines

public static long getNumberOfFillUpLines(long lastUnixTimeStamp,
                                          long loggingInterval)

getErrorValues

public static java.lang.StringBuilder getErrorValues(java.lang.String[] lineArray)

Returns the error value as a StringBuilder.

Parameters:

lineArray - a ascii line as a array with error code

Returns:

StringBuilder with appended error