scriptella.text

Class PropertyFormatInfo

java.lang.Object

scriptella.text.PropertyFormatInfo

public class PropertyFormatInfo
extends java.lang.Object

Holds metadata about properties format.

Used for storing formatting/parsing rules of CSV and other text files.

Version:

1.1

Author:

Fyodor Kupolov

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_NAME
static java.lang.String	LOCALE
static java.lang.String	NULL_STRING
static java.lang.String	PAD_CHAR
static java.lang.String	PAD_LEFT
static java.lang.String	PAD_RIGHT
static java.lang.String	PATTERN
static java.lang.String	TRIM
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor and Description
PropertyFormatInfo(java.util.Map<java.lang.String,PropertyFormat> formatMap)
PropertyFormatInfo(java.util.Map<java.lang.String,PropertyFormat> formatMap, PropertyFormat defaultFormat) Create an instance using a map of columns formats and a default format to use for undeclared columns.

Method Summary

Modifier and Type	Method and Description
static PropertyFormatInfo	createEmpty() Creates an empty format without columns.
PropertyFormat	getDefaultFormat()
PropertyFormat	getPropertyFormat(java.lang.String propertyName) Returns format for a specified property.
boolean	isEmpty()
static PropertyFormatInfo	parse(ConnectionParameters params, java.lang.String prefix)
static PropertyFormatInfo	parse(TypedPropertiesSource properties, java.lang.String prefix) Creates a PropertyFormatInfo from specified properties.
protected static void	setProperty(PropertyFormat f, java.lang.String columnPropName, java.lang.String key, TypedPropertiesSource ps)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NULL_STRING

public static final java.lang.String NULL_STRING

See Also:

Constant Field Values

TRIM

public static final java.lang.String TRIM

See Also:

Constant Field Values

CLASS_NAME

public static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

PATTERN

public static final java.lang.String PATTERN

See Also:

Constant Field Values

LOCALE

public static final java.lang.String LOCALE

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

PAD_LEFT

public static final java.lang.String PAD_LEFT

See Also:

Constant Field Values

PAD_RIGHT

public static final java.lang.String PAD_RIGHT

See Also:

Constant Field Values

PAD_CHAR

public static final java.lang.String PAD_CHAR

See Also:

Constant Field Values

Constructor Detail

PropertyFormatInfo

public PropertyFormatInfo(java.util.Map<java.lang.String,PropertyFormat> formatMap)

PropertyFormatInfo

public PropertyFormatInfo(java.util.Map<java.lang.String,PropertyFormat> formatMap,
                          PropertyFormat defaultFormat)

Create an instance using a map of columns formats and a default format to use for undeclared columns.

Parameters:

formatMap -

defaultFormat - default format for undeclared columns. It does not have impact on formatting rules defined in formatMap.

Method Detail

getPropertyFormat

public PropertyFormat getPropertyFormat(java.lang.String propertyName)

Returns format for a specified property.

Parameters:

propertyName - property name.

Returns:

format for a specified property.

isEmpty

public boolean isEmpty()

getDefaultFormat

public PropertyFormat getDefaultFormat()

parse

public static PropertyFormatInfo parse(ConnectionParameters params,
                                       java.lang.String prefix)

parse

public static PropertyFormatInfo parse(TypedPropertiesSource properties,
                                       java.lang.String prefix)

Creates a PropertyFormatInfo from specified properties. The properties file has the following structure:

     [prefix]propertyName.key=value
 

Parameters:

properties - properties defining formatting.

prefix - prefix for recognizing formatting properties. Nulls not allowed

Returns:

PropertyFormatInfo with a specified column formatting.

setProperty

protected static void setProperty(PropertyFormat f,
                                  java.lang.String columnPropName,
                                  java.lang.String key,
                                  TypedPropertiesSource ps)

createEmpty

public static PropertyFormatInfo createEmpty()

Creates an empty format without columns.

Returns:

an empty format without columns.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object