CommonCrawlFormatFactory.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.nutch.tools;

import java.io.IOException;

import org.apache.hadoop.conf.Configuration;
import org.apache.nutch.metadata.Metadata;
import org.apache.nutch.protocol.Content;

/**
 * Factory class that creates new {@link org.apache.nutch.tools.CommonCrawlFormat CommonCrawlFormat} objects (a.k.a. formatter) that map crawled files to CommonCrawl format.   
 *
 */
public class CommonCrawlFormatFactory {
	
	/**
	 * Returns a new instance of a {@link org.apache.nutch.tools.CommonCrawlFormat CommonCrawlFormat} object specifying the type of formatter. 
	 * @param formatType the type of formatter to be created.
	 * @param url the url.
	 * @param content the content.
	 * @param metadata the metadata.
	 * @param nutchConf the configuration.
	 * @param config the CommonCrawl output configuration.
	 * @return the new {@link org.apache.nutch.tools.CommonCrawlFormat CommonCrawlFormat} object.
	 * @throws IOException If any I/O error occurs.
	 * @deprecated
	 */
	public static CommonCrawlFormat getCommonCrawlFormat(String formatType, String url, Content content,	Metadata metadata, Configuration nutchConf, CommonCrawlConfig config) throws IOException {
		if (formatType == null) {
			return null;
		}
		
		if (formatType.equalsIgnoreCase("jackson")) {
			return new CommonCrawlFormatJackson(url, content, metadata, nutchConf, config);
		}
		else if (formatType.equalsIgnoreCase("jettinson")) {
			return new CommonCrawlFormatJettinson(url, content, metadata, nutchConf, config);
		}
		else if (formatType.equalsIgnoreCase("simple")) {
			return new CommonCrawlFormatSimple(url, content, metadata, nutchConf, config);
		}
		
		return null;
	}

	// The format should not depend on variable attributes, essentially this
	// should be one for the full job
	public static CommonCrawlFormat getCommonCrawlFormat(String formatType, Configuration nutchConf, CommonCrawlConfig config) throws IOException {
		if (formatType.equalsIgnoreCase("WARC")) {
			return new CommonCrawlFormatWARC(nutchConf, config);
		}

		if (formatType.equalsIgnoreCase("JACKSON")) {
			return new CommonCrawlFormatJackson( nutchConf, config);
		}
		return null;
	}
}