com.socrata.model.importer

Class ScanSummary

java.lang.Object

com.socrata.model.importer.ScanSummary

public class ScanSummary
extends Object

The summary of the results returned by scanning a CSV.

Field Summary

Fields

Modifier and Type	Field and Description
List<ScanColumn>	columns
int	headers
List<PossibleLocation>	locations
String	summary

Constructor Summary

Constructors

Constructor and Description
ScanSummary(String summary, int headers, List<ScanColumn> columns, List<PossibleLocation> locations)

Method Summary

Methods

Modifier and Type	Method and Description
List<ScanColumn>	getColumns()
int	getHeaders()
List<PossibleLocation>	getLocations()
String	getSummary()

Methods inherited from class java.lang.Object

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

Field Detail

summary

public final String summary

headers

public final int headers

columns

public final List<ScanColumn> columns

locations

public final List<PossibleLocation> locations

Constructor Detail

ScanSummary

public ScanSummary(String summary,
           int headers,
           List<ScanColumn> columns,
           List<PossibleLocation> locations)

Parameters:

summary - Human readable summary of the scan

headers - Number of rows that the scan believes contains the headers

columns - Results of the scan for each column and their suggested types

locations - the columns that can possibly be part of a location

Method Detail

getSummary

public String getSummary()

getHeaders

public int getHeaders()

getColumns

public List<ScanColumn> getColumns()

getLocations

public List<PossibleLocation> getLocations()