LogLine.java

/**
 * File ./src/main/java/de/lemo/dms/connectors/chemgapedia/fizHelper/LogLine.java
 * Lemo-Data-Management-Server for learning analytics.
 * Copyright (C) 2013
 * Leonard Kappe, Andreas Pursian, Sebastian Schwarzrock, Boris Wenzlaff
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
**/

/**
 * File ./main/java/de/lemo/dms/connectors/chemgapedia/fizHelper/LogLine.java
 * Date 2013-01-24
 * Project Lemo Learning Analytics
 */

package de.lemo.dms.connectors.chemgapedia.fizHelper;

import de.lemo.dms.connectors.Encoder;

/**
 * Class for parsing a line of a Log-file into its parts. Can be modified, if the Log-file format changes.
 * 
 * @author s.schwarzrock
 */
public class LogLine implements Comparable<LogLine> {

	/** Id, which is basically the users hashed IP-address. */
	private String id;

	/** URL, the user requested. */
	private String url;

	/** Referrer. */
	private String referrer;

	/** Timestamp. */
	private Long timestamp;

	/** HTTP status of the request. */
	private String httpStatus;

	/** The is valid. */
	private boolean isValid;

	@Override
	public int compareTo(final LogLine o) {
		LogLine s;
		try {
			s = o;
		} catch (final Exception e)
		{
			return 0;
		}
		if (this.timestamp > s.getTimestamp()) {
			return 1;
		}
		if (this.timestamp < s.getTimestamp()) {
			return -1;
		}
		return 0;
	}

	/**
	 * Constructor of the class. Parses the given line from the server-log-line and puts the found values into the
	 * object's fields.
	 * 
	 * @param logLine
	 *            single line taken from the server-log-file
	 */
	public LogLine(final String logLine)
	{
		final String[] lineArguments = logLine.split("\t");
		if (lineArguments.length > 5)
		{
			this.isValid = true;
			// Set id
			if (lineArguments[2].split("/").length == 2) {
				// IF Cookie is set use Cookie-ID
				this.id = Encoder.createMD5(lineArguments[2].split("/")[0].trim()) + "/"
						+ lineArguments[2].split("/")[1];
			}
			else {
				// use IP else
				this.id = Encoder.createMD5(lineArguments[3].trim()) + "";
			}

			// Set timestamp
			this.timestamp = Long.parseLong(lineArguments[0]);
			if (!lineArguments[4].trim().startsWith("http://www.chemgapedia.de")) {
				this.url = "http://www.chemgapedia.de" + lineArguments[4].trim();
			} else {
				this.url = lineArguments[4].trim();
			}
			if (this.url.contains("\\")) {
				this.isValid = false;
			}

			// Set HTTP-status
			this.httpStatus = lineArguments[1].trim();

			// Set referrer
			if (!lineArguments[5].contains("www.google.")) {
				this.referrer = lineArguments[5].trim();
			} else {
				this.referrer = "-";
			}
		} else {
			this.isValid = false;
		}
	}

	/**
	 * Checks if the line is valid.
	 * 
	 * @return true, if is valid
	 */
	public boolean isValid() {
		return this.isValid;
	}

	/**
	 * Gets the HTTP status.
	 * 
	 * @return the HTTP status
	 */
	public String getHttpStatus() {
		return this.httpStatus;
	}

	/**
	 * Sets the HTTP status.
	 * 
	 * @param httpStatus
	 *            the new HTTP status
	 */
	public void setHttpStatus(final String httpStatus) {
		this.httpStatus = httpStatus;
	}

	/**
	 * Gets the timestamp.
	 * 
	 * @return the timestamp
	 */
	public Long getTimestamp() {
		return this.timestamp;
	}

	/**
	 * Sets the timestamp.
	 * 
	 * @param timestamp
	 *            the new timestamp
	 */
	public void setTimestamp(final Long timestamp) {
		this.timestamp = timestamp;
	}

	/**
	 * Sets the id.
	 * 
	 * @param id
	 *            the new id
	 */
	public void setId(final String id) {
		this.id = id;
	}

	/**
	 * Gets the id.
	 * 
	 * @return the id
	 */
	public String getId() {
		return this.id;
	}

	/**
	 * Gets the URL.
	 * 
	 * @return the URL
	 */
	public String getUrl() {
		return this.url;
	}

	/**
	 * Sets the URL.
	 * 
	 * @param url
	 *            the new URL
	 */
	public void setUrl(final String url) {
		this.url = url;
	}

	/**
	 * Gets the referrer.
	 * 
	 * @return the referrer
	 */
	public String getReferrer() {
		return this.referrer;
	}

	/**
	 * Sets the referrer.
	 * 
	 * @param referrer
	 *            the new referrer
	 */
	public void setReferrer(final String referrer) {
		this.referrer = referrer;
	}

}