DelimitedColumnEntityFormat (LensKit 3.0-SNAPSHOT)

java.lang.Object
- org.lenskit.data.dao.file.DelimitedColumnEntityFormat

All Implemented Interfaces:: EntityFormat

public class DelimitedColumnEntityFormat
extends java.lang.Object
implements EntityFormat

Delimited text column entity format.

Constructor Summary

Constructors
Constructor and Description

DelimitedColumnEntityFormat()

Constructors
Constructor and Description
`DelimitedColumnEntityFormat()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(java.lang.String label, TypedName<?> attr)` Add a column.
`void`	`addColumn(TypedName<?> attr)` Associate an attribute with the next column.
`void`	`addColumns(TypedName<?>... columns)` Add columns to a format.
`void`	`clearColumns()` Clear the columns configured for this format.
`static DelimitedColumnEntityFormat`	`fromJSON(java.lang.String name, java.lang.ClassLoader loader, com.fasterxml.jackson.databind.JsonNode json)`
`AttributeSet`	`getAttributes()` Get the set of attributes entities from format may have, if known.
`long`	`getBaseId()` Get the base entity ID for this source.
`java.util.List<TypedName<?>>`	`getColumnList()` Get the list of columns, if `addColumn(TypedName)` has been used.
`java.lang.String`	`getDelimiter()` Get the delimiter for the entity format.
`java.lang.Class<? extends EntityBuilder>`	`getEntityBuilder()` Get the entity builder class.
`EntityType`	`getEntityType()` Get the entity type.
`int`	`getHeaderLines()` Get the number of header lines to read.
`LineEntityParser`	`makeParser(java.util.List<java.lang.String> header)` Create an entity parser for a file.
`EntityBuilder`	`newEntityBuilder()` Instantiate a new entity builder.
`void`	`setBaseId(long base)` Set the base entity ID for this source.
`void`	`setDelimiter(java.lang.String delim)` Set the delimiter to use for this entity format.
`void`	`setEntityBuilder(java.lang.Class<? extends EntityBuilder> builder)` Set the entity builder class.
`void`	`setEntityType(EntityType type)` Set the entity type.
`void`	`setHeader(boolean header)` Set whether to read a header.
`void`	`setHeaderLines(int lines)` Set the number of header lines to read.
`com.fasterxml.jackson.databind.node.ObjectNode`	`toJSON()` Create a JSON description of this entity format.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DelimitedColumnEntityFormat
```
public DelimitedColumnEntityFormat()
```
- Method Detail
  - getDelimiter
```
public java.lang.String getDelimiter()
```
    Get the delimiter for the entity format.
    
    Returns:
    
    The entity format delimiter.
  - setDelimiter
```
public void setDelimiter(java.lang.String delim)
```
    Set the delimiter to use for this entity format.
    
    Parameters:
    
    delim - The delimiter to use.
  - setHeader
```
public void setHeader(boolean header)
```
    Set whether to read a header.
    
    Parameters:
    
    header - true to read a header line from the file.
  - getHeaderLines
```
public int getHeaderLines()
```
    Get the number of header lines to read.
    
    Specified by:
    
    getHeaderLines in interface EntityFormat
    
    Returns:
    
    The number of header lines to read.
  - setHeaderLines
```
public void setHeaderLines(int lines)
```
    Set the number of header lines to read. Setting this disables setHeader(boolean).
    
    Parameters:
    
    lines - The number of header lines to read.
  - getBaseId
```
public long getBaseId()
```
    Get the base entity ID for this source.
    
    Returns:
    
    The base entity ID.
  - setBaseId
```
public void setBaseId(long base)
```
    Set the base entity ID for this source. If an entity column is not defined, then the line number will be added to this value to obtain a synthetic ID.
    
    Parameters:
    
    base - The base entity ID.
  - setEntityType
```
public void setEntityType(EntityType type)
```
    Set the entity type.
    
    Parameters:
    
    type - The entity type.
  - getEntityType
```
public EntityType getEntityType()
```
    Get the entity type.
    
    Specified by:
    
    getEntityType in interface EntityFormat
    
    Returns:
    
    The entity type.
  - setEntityBuilder
```
public void setEntityBuilder(java.lang.Class<? extends EntityBuilder> builder)
```
    Set the entity builder class.
    
    Parameters:
    
    builder - The entity builder class.
  - getEntityBuilder
```
public java.lang.Class<? extends EntityBuilder> getEntityBuilder()
```
    Get the entity builder class.
    
    Specified by:
    
    getEntityBuilder in interface EntityFormat
    
    Returns:
    
    The entity builder class.
  - getAttributes
```
@Nullable
public AttributeSet getAttributes()
```
    Description copied from interface: EntityFormat
    
    Get the set of attributes entities from format may have, if known.
    
    Specified by:
    
    getAttributes in interface EntityFormat
    
    Returns:
    
    The set of attributes that entities may have, or null if that information is not known.
  - newEntityBuilder
```
public EntityBuilder newEntityBuilder()
```
    Instantiate a new entity builder.
    
    Returns:
    
    A new entity builder.
  - addColumn
```
public void addColumn(@Nullable
                      TypedName<?> attr)
```
    Associate an attribute with the next column. The first time this is called it specifies the label for the first column. The second time this is called it specifies the second column label and so forth.
    Once this method has been called, addColumn(String, TypedName) cannot be called.
    
    Parameters:
    
    attr - The attribute to add as a column, or null to skip the next column.
    
    Throws:
    
    java.lang.IllegalStateException - if non-labeled columns have already been specified.
  - addColumns
```
public void addColumns(TypedName<?>... columns)
```
    Add columns to a format. This is exactly equivalent to calling addColumn(TypedName) for each column.
    
    Parameters:
    
    columns - The columns to add.
  - getColumnList
```
public java.util.List<TypedName<?>> getColumnList()
```
    Get the list of columns, if addColumn(TypedName) has been used.
    
    Returns:
    
    The list of columns.
    
    Throws:
    
    java.lang.IllegalStateException - if addColumn(TypedName) or addColumns(TypedName[]) have not been called.
  - addColumn
```
public void addColumn(java.lang.String label,
                      @Nullable
                      TypedName<?> attr)
```
    Add a column.
    
    Parameters:
    
    label - The header label.
    
    attr - The attribute to add as a column, or null to skip the next column.
    
    Throws:
    
    java.lang.IllegalStateException - if non-labeled columns have already been specified.
  - clearColumns
```
public void clearColumns()
```
    Clear the columns configured for this format.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toJSON
```
public com.fasterxml.jackson.databind.node.ObjectNode toJSON()
```
    Description copied from interface: EntityFormat
    
    Create a JSON description of this entity format.
    
    Specified by:
    
    toJSON in interface EntityFormat
    
    Returns:
    
    The JSON description.
  - fromJSON
```
public static DelimitedColumnEntityFormat fromJSON(java.lang.String name,
                                                   java.lang.ClassLoader loader,
                                                   com.fasterxml.jackson.databind.JsonNode json)
```
  - makeParser
```
public LineEntityParser makeParser(java.util.List<java.lang.String> header)
```
    Description copied from interface: EntityFormat
    
    Create an entity parser for a file.
    
    Specified by:
    
    makeParser in interface EntityFormat
    
    Parameters:
    
    header - The header lines.
    
    Returns:
    
    A parser that will make entity lines from entities.

Class DelimitedColumnEntityFormat

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DelimitedColumnEntityFormat

Method Detail

getDelimiter

setDelimiter

setHeader

getHeaderLines

setHeaderLines

getBaseId

setBaseId

setEntityType

getEntityType

setEntityBuilder

getEntityBuilder

getAttributes

newEntityBuilder

addColumn

addColumns

getColumnList

addColumn

clearColumns

toString

toJSON

fromJSON

makeParser