org.pageseeder.flint.content.Content Maven / Gradle / Ivy
/*
* Copyright 2015 Allette Systems (Australia)
* http://www.allette.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 org.pageseeder.flint.content;
import java.io.File;
import java.io.InputStream;
import org.pageseeder.flint.IndexException;
/**
* This class provides a way for the IndexManager to fetch the content to add to the index.
*
* Content is identified by its ContentID and its Media Type.
*
* @see MIME Part Two: Media Types
* @see XML Media Types
*
* @author Jean-Baptiste Reure
* @author Christophe Lauret
* @version 29 July 2010
*/
public interface Content {
/**
* @return the unique ID for this content.
*/
String getContentID();
/**
* @return the content type.
*/
ContentType getContentType();
/**
* Returns the content as a stream, ready to be translated.
*
*
Implementations can choose to provide the content as a stream or as a File.
*
*
Implementations should buffer large content.
*
* @return the stream where the Content is read from
*
* @throws IndexException Should any error occur when retrieving the source.
*/
InputStream getSource() throws IndexException;
/**
* Returns the content as a file, ready to be translated.
*
*
Implementations can choose to provide the content as a stream or as a File.
*
* @return the file where the Content is read from
*
* @throws IndexException Should any error occur when retrieving the source.
*/
File getFile() throws IndexException;
/**
* Load the media type for the content.
*
* @see MIME Part Two: Media Types
* @see XML Media Types
*
* @return a String representation of the media type.
*
* @throws IndexException Should any error occur when retrieving the value.
*/
String getMediaType() throws IndexException;
/**
* Return true if the content should be deleted from the index.
*
* @return true if the content should be deleted from the index, false otherwise.
*
* @throws IndexException Should any error occur when retrieving the value.
*/
boolean isDeleted() throws IndexException;
/**
* Returns the rule used to delete the previous content.
*
*
This is used for updating a document or a simple delete job.
*
* @return a DeleteRule object
*/
DeleteRule getDeleteRule();
}