<flatfile/>

FlatFileDataSource provides data from flat files representing database tables.
Implemented by:
thinkmap.datasource.flatfile2.FlatFileDataSource

Simple Attributes

createNewIndexOnStart

description: If set to true, the server will create a new index each time on startup.

type: boolean

required: No


default: false
debugLevel

description: Sets the debug level for this datasource. The levels are mapped to the IThinkmapContext levels. The default setting is MSG_INFO (4) which means that any message with a debug level less than or equal to MSG_INFO will be reported to the user.

type: int

required: No

defaultMaxSearchResults

description: Set's the default number of max search results that is returned by a search request. This can be overridden by individual client requests via the use of the MAX_SEARCH_RESULTS attribute in a message.

type: int

required: No


default: 100
errorThreshold

description: Set's the error threshold for processing a file which is the number of errors that must take place before the file is abandoned entirely.

type: int

required: No


default: 15
indexingNotificationInterval

description: Set's the indexing notification interval which determines how many lines must be processed before notifying the server of indexing progress.

type: int

required: No


default: 100000;
indexPath

description: Set's the directory where this index will be stored. If not specified, or if the server cannot create a directory or write to this directory, then a temporary directory is used for the index.

type: java.io.File

required: No

memoryOnly

description: Set's where this datasource should be stored entirely in memory. This means that the ds will be indexed everytime at startup rather than use the file system. This can lead to much faster lookup times but a bigger memory footprint.

type: boolean

required: No


default: false
warningThreshold

description: Set's the warning threshold for processing a file. This is the number of warnings that will take place before the datasource stops notifying you about warnings. This is so a user is not overwhelmed by the number of messages.

type: int

required: No


default: 15

Children

<edge/>A flat file edge.

Simple Attributes

bidirectional

description: Set whether or not this edge is bidirectional

type: boolean

required: No


default: true
delimiter

description: Set the delimiter character for this file. The default is a tab except when the file ends in csv, where a comma is used as a delimiter.

type: char

required: No


default: a tab for all none csv files. CSV files use commas as their delimiter.
encoding

description: Sets the encoding to use when reading the file. (e.g. UTF8) The default is the platform's default character encoding.

type: String

required: No


default: The systems default character encoding
escapeChar

description: Set's the character used for escaping special characters like quotes. The default is backslash \

type: char

required: No


default: a backslash \
from

description: Set the NodeEntityModel representing this edge's source.

type: String

required: Yes

maxResults

description: Set the maximum number of entities that should be returned.

type: int

required: No


default: No maximum
name

description: Set the name of this EntityModel. This is the Entity's type.

type: String

required: Yes

parent

description: Set the parent entity type of this entity.

type: String

required: No

quoteChar

description: Set's the quote character. The default is the standard quote.

type: char

required: No


default: the standard quote character (")
skipRows

description: Set to the number of rows to skip at the top of the file.

type: int

required: No


default: 0
table

description: Set the name of the table represented by this EntityModel.

type: String

required: No

to

description: Set the NodeEntityModel representing this edge's sink.

type: String

required: Yes

Children

<column/>A flat file column.

Simple Attributes

alias

description: Sets the name of the property that this column will produce. If none is specified, then the name will be the same as the column name.

type: String

required: No

bindColumn

description: Set the node column that the value in this edge column must bind to. This is used to determine which node will connect to the edge. In a database, this is a foreign key column mapping.

type: String

required: No

bindTo

description: Set the foreign key table mapping for this column.

type: String

required: No

dateFormat

description: Set the date format string for this column. Only applicable if column type is date. The is a date format string is defined in java SimpleDateFormat.

If no date format string is specified, a date value will be interpreted as milliseconds since January 1, 1970.



type: String

required: No

key

description: Set whether or not the column represented by this column is an ID key.

type: boolean

required: No

name

description: Set the name of this column

type: String

required: No

property

description: Set whether or not this column should be used as a property in the datasource.

type: boolean

required: No


default: False
type

description: Set the type of data this column represents.

type: Class

required: Yes

useEmptyString

description: If set to true, an empty string will be kept. If not, then it will be set as null.

type: boolean

required: No

<node/>A flat file node.

Simple Attributes

cache

description:

type: boolean

required: No

delimiter

description: Set the delimiter character for this file. The default is a tab except when the file ends in csv, where a comma is used as a delimiter.

type: char

required: No


default: a tab for all none csv files. CSV files use commas as their delimiter.
encoding

description: Sets the encoding to use when reading the file. (e.g. UTF8) The default is the platform's default character encoding.

type: String

required: No


default: The systems default character encoding
escapeChar

description: Set's the character used for escaping special characters like quotes. The default is backslash \

type: char

required: No


default: a backslash \
maxResults

description: Set the maximum number of entities that should be returned.

type: int

required: No


default: No maximum
name

description: Set the name of this EntityModel. This is the Entity's type.

type: String

required: Yes

parent

description: Set the parent entity type of this entity.

type: String

required: No

quoteChar

description: Set's the quote character. The default is the standard quote.

type: char

required: No


default: the standard quote character (")
skipRows

description: Set to the number of rows to skip at the top of the file.

type: int

required: No


default: 0
table

description: Set the name of the table represented by this EntityModel.

type: String

required: No

Children

<column/>A flat file column.

Simple Attributes

alias

description: Sets the name of the property that this column will produce. If none is specified, then the name will be the same as the column name.

type: String

required: No

dateFormat

description: Set the date format string for this column. Only applicable if column type is date. The is a date format string is defined in java SimpleDateFormat.

If no date format string is specified, a date value will be interpreted as milliseconds since January 1, 1970.



type: String

required: No

key

description: Set whether or not the column represented by this column is an ID key.

type: boolean

required: No

name

description: Set the name of this column

type: String

required: No

property

description: Set whether or not this column should be used as a property in the datasource.

type: boolean

required: No


default: False
type

description: Set the type of data this column represents.

type: Class

required: Yes

useEmptyString

description: If set to true, an empty string will be kept. If not, then it will be set as null.

type: boolean

required: No