LiveGraph
data visualisation and analysis framework

org.LiveGraph.dataFile.common
Class DataFormatTools

java.lang.Object
  extended by org.LiveGraph.dataFile.common.DataFormatTools

public class DataFormatTools
extends java.lang.Object

This convenience class defines special tags for the LiveGraph data file format.

This product includes software developed by the LiveGraph project and its contributors.
(http://www.live-graph.org)
Copyright (c) 2007 G. Paperin.
All rights reserved.

File: DataFormatTools.java

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following terms and conditions are met:

1. Redistributions of source code must retain the above acknowledgement of the LiveGraph project and its web-site, the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above acknowledgement of the LiveGraph project and its web-site, the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software or any derived software must display the following acknowledgement:
This product includes software developed by the LiveGraph project and its contributors.
(http://www.live-graph.org)

4. All advertising materials distributed in form of HTML pages or any other technology permitting active hyper-links that mention features or use of this software or any derived software must display the acknowledgment specified in condition 3 of this agreement, and in addition, include a visible and working hyper-link to the LiveGraph homepage (http://www.live-graph.org).

THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version:
"1.1.1"
Author:
Greg Paperin (http://www.paperin.org)

Field Summary
static java.lang.String DefaultSeparator
          This is the default data separator tag.
static java.lang.String TAGComment
          Every comment line must start with this tag.
static java.lang.String TAGFileInfo
          Every file description line must start with this tag.
static java.lang.String TAGSepDefinition
          An alternatice separator definition in the first line of the file must be ocated wetween two instances of this tag.
 
Constructor Summary
DataFormatTools()
           
 
Method Summary
static java.lang.String isValidSeparator(java.lang.String separator)
          In order to read the data correctly a tag must not be confused with data value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TAGComment

public static final java.lang.String TAGComment
Every comment line must start with this tag.

See Also:
Constant Field Values

TAGFileInfo

public static final java.lang.String TAGFileInfo
Every file description line must start with this tag.

See Also:
Constant Field Values

TAGSepDefinition

public static final java.lang.String TAGSepDefinition
An alternatice separator definition in the first line of the file must be ocated wetween two instances of this tag.

See Also:
Constant Field Values

DefaultSeparator

public static final java.lang.String DefaultSeparator
This is the default data separator tag.

See Also:
Constant Field Values
Constructor Detail

DataFormatTools

public DataFormatTools()
Method Detail

isValidSeparator

public static java.lang.String isValidSeparator(java.lang.String separator)
In order to read the data correctly a tag must not be confused with data value. This method checks whther a separator tag is valid. Note that while this method check for most common problems, it does not guarantee a correct separator.

Parameters:
separator - A proposed data deparator string.
Returns:
true if the specified separetor tag can be used with double data values; false if the specified tag is not valid.

LiveGraph
data visualisation and analysis framework