org.smooks.cartridges.flatfile

Class RecordMetaData

java.lang.Object

org.smooks.cartridges.flatfile.RecordMetaData

public class RecordMetaData
extends Object

Record metadata.

Author:

tom.fennelly@gmail.com

Constructor Summary

Constructors

Constructor and Description
RecordMetaData(String name, List<FieldMetaData> fields) public constructor.
RecordMetaData(String name, List<FieldMetaData> fields, boolean wildCardRecord) public constructor.

Method Summary

Modifier and Type	Method and Description
void	assertValidFieldName(String fieldName) Assert that the supplied field name is one of the field names associated with this record.
List<String>	getFieldNames() Get a collection of all the field names (excluding ignored fields) in this record.
List<FieldMetaData>	getFields() Get the record fields metadata.
int	getIgnoredFieldCount() Get the number of fields in this record that are ignored.
String	getName() Get the record name.
int	getUnignoredFieldCount() Get the number of fields in this record that are not ignored.
boolean	isWildCardRecord() Is this a wildcard record.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordMetaData

public RecordMetaData(String name,
                      List<FieldMetaData> fields)

public constructor.

Parameters:

name - Record name.

fields - Record fields metadata.

RecordMetaData

public RecordMetaData(String name,
                      List<FieldMetaData> fields,
                      boolean wildCardRecord)

public constructor.

Parameters:

name - Record name.

fields - Record fields metadata.

wildCardRecord - Wildcard record. Accept any fields and generate the field names based on index.

Method Detail

getName

public String getName()

Get the record name.

Returns:

The record name.

getFields

public List<FieldMetaData> getFields()

Get the record fields metadata.

Returns:

The record fields metadata.

isWildCardRecord

public boolean isWildCardRecord()

Is this a wildcard record.

If it is, accept all fields and use the field index to generate the field name.

Returns:

True of this is a wildcard record, otherwise false.

getIgnoredFieldCount

public int getIgnoredFieldCount()

Get the number of fields in this record that are ignored.

Returns:

The number of fields in this record that are ignored.

getUnignoredFieldCount

public int getUnignoredFieldCount()

Get the number of fields in this record that are not ignored.

Returns:

The number of fields in this record that are not ignored.

getFieldNames

public List<String> getFieldNames()

Get a collection of all the field names (excluding ignored fields) in this record.

Returns:

Acollection of all the field names in this record.

assertValidFieldName

public void assertValidFieldName(String fieldName)

Assert that the supplied field name is one of the field names associated with this record.

Parameters:

fieldName - The field name to test.