org.sakaiproject.component.legacy.calendar.readers
Class MeetingMakerReader

java.lang.Object
  extended byorg.sakaiproject.component.legacy.calendar.readers.Reader
      extended byorg.sakaiproject.component.legacy.calendar.readers.MeetingMakerReader

public class MeetingMakerReader
extends Reader

This class parses an import file from MeetingMaker.


Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.component.legacy.calendar.readers.Reader
Reader.ColumnHeader, Reader.ReaderImportCell, Reader.ReaderImportRowHandler
 
Field Summary
static String AGENDA_NOTES_HEADER
           
static String DATE_HEADER
           
static String DURATION_HEADER
           
static String LOCATION_HEADER
           
static String START_TIME_HEADER
           
static String TITLE_HEADER
           
 
Fields inherited from class org.sakaiproject.component.legacy.calendar.readers.Reader
columnHeaderMap, timeService
 
Constructor Summary
MeetingMakerReader()
          Default constructor
 
Method Summary
 List filterEvents(List events, String[] customFieldNames)
          Each derived class must implement this filter to convert the properties as set by the reader into a common set of properties that will be used to create calendar events.
 Map getDefaultColumnMap()
          Derived classes must provide a default mapping of text column header labels in the import file to calendar event properties.
 void importStreamFromDelimitedFile(InputStream stream, Reader.ReaderImportRowHandler handler)
          Import a CSV file from a stream and callback on each row.
 
Methods inherited from class org.sakaiproject.component.legacy.calendar.readers.Reader
buildColumnDescriptionArray, getColumnHeaderMap, getReader, getTimeService, processLine, setColumnHeaderToAtributeMapping, setTimeService, trimLeadingTrailingQuotes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TITLE_HEADER

public static final String TITLE_HEADER
See Also:
Constant Field Values

LOCATION_HEADER

public static final String LOCATION_HEADER
See Also:
Constant Field Values

DATE_HEADER

public static final String DATE_HEADER
See Also:
Constant Field Values

START_TIME_HEADER

public static final String START_TIME_HEADER
See Also:
Constant Field Values

DURATION_HEADER

public static final String DURATION_HEADER
See Also:
Constant Field Values

AGENDA_NOTES_HEADER

public static final String AGENDA_NOTES_HEADER
See Also:
Constant Field Values
Constructor Detail

MeetingMakerReader

public MeetingMakerReader()
Default constructor

Method Detail

importStreamFromDelimitedFile

public void importStreamFromDelimitedFile(InputStream stream,
                                          Reader.ReaderImportRowHandler handler)
                                   throws ImportException
Description copied from class: Reader
Import a CSV file from a stream and callback on each row.

Specified by:
importStreamFromDelimitedFile in class Reader
Parameters:
stream - Stream of CSV (or other delimited data)
handler - Callback for each row.
Throws:
ImportException

filterEvents

public List filterEvents(List events,
                         String[] customFieldNames)
                  throws ImportException
Description copied from class: Reader
Each derived class must implement this filter to convert the properties as set by the reader into a common set of properties that will be used to create calendar events. Notably, this filter must create a ScheduleImporterService.ACTUAL_TIMERANGE property that will define the actual start time/date of the event.

Specified by:
filterEvents in class Reader
Parameters:
customFieldNames -
Throws:
ImportException

getDefaultColumnMap

public Map getDefaultColumnMap()
Description copied from class: Reader
Derived classes must provide a default mapping of text column header labels in the import file to calendar event properties.

Specified by:
getDefaultColumnMap in class Reader