dk.heick.properties.derived.generics

Class KeyMultiLineValuesFromTextFile

java.lang.Object

dk.heick.properties.derived.generics.KeyMultiLineValuesFromTextFile

All Implemented Interfaces:

TypeFromGeneric<File,Hashtable<String,List<List<String>>>>

public class KeyMultiLineValuesFromTextFile
extends Object
implements TypeFromGeneric<File,Hashtable<String,List<List<String>>>>

Parse a text file where there is key and values and each value can span over many lines.
For each key there can be many values and each value can be a list of strings, it is returned in Hashtable<String,List<List<String>>>.
This is used by me as a quick solution to read data from text files.
Reads each line with the following rules:

*
• If line starts with comment indicator, it is ignored.
• If line starts with key indicator, the rest of th eline is considered to be the key, all lines be below is its values, until the next key is encountered.
• The "key" must be a none empty string.
*

Example:

 !key1
 value1 line1
 value1 line2
 #value1 ignored
 value1 line3
 !key2
 value2 line1
 !key1
 value3 line1
 value3 line2
 value3 line3
 !key3
 #value4 ignored
 value4 line1
 value4 line2
 

Since:

2.0

Author:

Frederik Heick

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COMMENT_INDICATOR The default comment indicator, "#", if the line starts with this, it is ignored.
static String	DEFAULT_KEY_INDICATOR The default key indicator "!"

Constructor Summary

Constructors

Constructor and Description
KeyMultiLineValuesFromTextFile() Default constructor using DEFAULT_KEY_INDICATOR and DEFAULT_COMMENT_INDICATOR
KeyMultiLineValuesFromTextFile(String keyIndicator, String commentIndicator) Constructor

Method Summary

Modifier and Type	Method and Description
Hashtable<String,List<List<String>>>	fromType(String propertyName, File from) The method which converts K to the type T.
String	getCommentIndicator() The string which indicates that a String is a comment, if it starts with this.
String	getKeyIndicator() The key indictor
org.apache.commons.logging.Log	getLogger() Gets a logger.
List<String>	getRestrictions() Gets a detailed description of the TypeFromGeneric with any constraints that might influence the validation.
String	getTypeName() The simpel short name.
void	validateConstraints(String propertyName) Validates the constraints for the type.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEY_INDICATOR

public static final String DEFAULT_KEY_INDICATOR

The default key indicator "!"

See Also:

Constant Field Values

DEFAULT_COMMENT_INDICATOR

public static final String DEFAULT_COMMENT_INDICATOR

The default comment indicator, "#", if the line starts with this, it is ignored.

See Also:

Constant Field Values

Constructor Detail

KeyMultiLineValuesFromTextFile

public KeyMultiLineValuesFromTextFile()

Default constructor using DEFAULT_KEY_INDICATOR and DEFAULT_COMMENT_INDICATOR

See Also:

DEFAULT_KEY_INDICATOR, DEFAULT_COMMENT_INDICATOR

KeyMultiLineValuesFromTextFile

public KeyMultiLineValuesFromTextFile(String keyIndicator,
                                      String commentIndicator)

Constructor

Parameters:

keyIndicator - the none empty string when which starts a line, it indicates that the rest of line is the key, and every line below is its values, until a new key or EOF.

commentIndicator - if a line starts with this string (indicator) it is ignore.

Method Detail

getKeyIndicator

public String getKeyIndicator()

The key indictor

Returns:

the keyIndicator the none empty string when which starts a line, it indicates that the rest of line is the key, and every line below is its values, until a new key or EOF.

getCommentIndicator

public String getCommentIndicator()

The string which indicates that a String is a comment, if it starts with this.

Returns:

the commentIndicator

fromType

public Hashtable<String,List<List<String>>> fromType(String propertyName,
                                                     File from)
                                              throws PropertyException

Description copied from interface: TypeFromGeneric

The method which converts K to the type T.

Specified by:

fromType in interface TypeFromGeneric<File,Hashtable<String,List<List<String>>>>

Parameters:

propertyName - the name of the property, this is Derived Property, not the Property which supplies the import for the type conversion.

from - the type K

Returns:

to the type T

Throws:

PropertyException - if the conversion could not be performed.

getTypeName

public String getTypeName()

Description copied from interface: TypeFromGeneric

The simpel short name. as "PublicKey from File"

Specified by:

getTypeName in interface TypeFromGeneric<File,Hashtable<String,List<List<String>>>>

Returns:

the short identifing type name.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Description copied from interface: TypeFromGeneric

Validates the constraints for the type.

Specified by:

validateConstraints in interface TypeFromGeneric<File,Hashtable<String,List<List<String>>>>

Parameters:

propertyName - the name of the property which validates the constraints, this is Derived Property, not the Property which supplies the import for the type conversion.

Throws:

PropertyException - if the constraints do not hold.

getRestrictions

public List<String> getRestrictions()

Description copied from interface: TypeFromGeneric

Gets a detailed description of the TypeFromGeneric with any constraints that might influence the validation.
This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.
Do NOT need to include the Property it is dependent on, since DerivedFromTypePropertyType will ensure that this is included.

Specified by:

getRestrictions in interface TypeFromGeneric<File,Hashtable<String,List<List<String>>>>

Returns:

the restictions as a list of Strings, please as unmodifiable.

See Also:

StringList, StringList.asUnmodifiableList()

getLogger

public org.apache.commons.logging.Log getLogger()

Description copied from interface: TypeFromGeneric

Gets a logger.

Specified by:

getLogger in interface TypeFromGeneric<File,Hashtable<String,List<List<String>>>>

Returns:

a logger