EventConverter.java

/*
 * This file is a component of thundr, a software library from 3wks.
 * Read more: http://www.3wks.com.au/thundr
 * Copyright (C) 2013 3wks, <thundr@3wks.com.au>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.threewks.thundr.bigquery;

/**
 * Used to convert an event into a suitable state to send to Google BigQuery.
 * 
 * @param <T> the event type.
 */
public interface EventConverter<T> {

	/**
	 * Get the id of the BigQuery table the event should be written to.
	 * 
	 * @return the table id.
	 */
	public String getTableId();

	/**
	 * Get the event data as a CSV string.
	 * 
	 * @param event the event to convert.
	 * @return the event data represented as a CSV string.
	 */
	public String getCsvData(T event);

	/**
	 * Get the event class.
	 * 
	 * @return the event class.
	 */
	public Class<T> getEventClass();

}