001/*
002 *  Copyright 2010 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.web.inputdata;
017
018import org.apache.cocoon.ProcessingException;
019import org.xml.sax.ContentHandler;
020import org.xml.sax.SAXException;
021
022import org.ametys.web.repository.page.Page;
023import org.ametys.web.repository.site.Site;
024
025/**
026 * Abstraction for providing data at view-time by SAXing events.
027 */
028public interface InputData
029{
030    /**
031     * Returns true if this {@link InputData} is cacheable for the current site and if possible page.
032     * @param site the current {@link Site}.
033     * @param page the current {@link Page}. Can be null.
034     * @return true if this {@link InputData} is cacheable for the current site or page.
035     */
036    public boolean isCacheable(Site site, Page page);
037    
038    /**
039     * Generates SAX events for providing data.
040     * @param handler the content handler to SAX into.
041     * @throws SAXException if an error occurs while SAXing.
042     * @throws ProcessingException if an error occurs during processing.
043     */
044    public void toSAX(ContentHandler handler) throws SAXException, ProcessingException;
045}