com.tectonica.jonix.Onix2Extractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jonix-onix2 Show documentation

Collection of classes for processing Onix-2 sources

There is a newer version: 2024-10-onix308-fix

/*
 * Copyright (C) 2012 Zach Melamed
 * 
 * Latest version available online at https://github.com/zach-m/jonix
 * Contact me at [email protected]
 *
 * 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.tectonica.jonix;

import org.w3c.dom.Element;

import com.tectonica.jonix.onix2.Header;
import com.tectonica.jonix.onix2.Product;
import com.tectonica.jonix.stream.JonixFilesExtractor;
import com.tectonica.jonix.stream.JonixStreamer;

/**
 * Simple abstract extractor for ONIX2-only sources. Can be used like that
 * 
 *  * JonixFilesStreamer streamer = new JonixFilesStreamer(new Onix2Extractor()
 * {
 * 	@Override
 * 	protected void onProduct(Product product, JonixStreamer streamer)
 * 	{
 * 		// do something with the product..
 * 	}
 * });
 * 
 * InputStream is = // your ONIX source
 * streamer.read(is);
 * 
 * 
 * Subclasses need to override {@link #onProduct(Product, JonixStreamer)} and optionally
 * {@link #onHeader(Header, JonixStreamer)}.
 */
public abstract class Onix2Extractor extends JonixFilesExtractor
{
	/**
	 * fired when a {@code Header} element is encountered in the ONIX file
	 * 
	 * @return whether or not to continue to the processing of the file
	 */
	protected boolean onHeader(Header header, JonixStreamer streamer)
	{
		return true;
	}

	/**
	 * fired when a {@code Product} element is encountered in the ONIX file
	 * 
	 * @return whether or not to continue to the processing of the file
	 */
	protected abstract boolean onProduct(Product product, JonixStreamer streamer);

	// ///////////////////////////////////////////////////////////////////////////////

	@Override
	protected boolean onHeaderElement(Element domHeader, JonixStreamer streamer)
	{
		return onHeader(new Header(domHeader), streamer);
	}

	@Override
	protected boolean onProductElement(Element domProduct, JonixStreamer streamer)
	{
		return onProduct(new Product(domProduct), streamer);
	}
}