com.randomcoder.content
Interface ContentFilter

All Known Implementing Classes:
MultiContentFilter, TextFilter, XHTMLFilter

public interface ContentFilter

Content filtering interface.

 Copyright (c) 2006, Craig Condit. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
     
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 


Method Summary
 String getPrefix(String contentType)
          Gets the data to prepend to a content stream before processing.
 String getSuffix(String contentType)
          Gets the data to append to a content stream before processing.
 XMLReader getXMLReader(URL baseUrl, String contentType)
          Gets an XML reader suitable for the given content type.
 Templates getXSLTemplates(String contentType)
          Gets XSL templates for the given content type.
 void validate(String contentType, Reader content)
          Validates the given input.
 

Method Detail

validate

void validate(String contentType,
              Reader content)
              throws InvalidContentException,
                     InvalidContentTypeException,
                     IOException
Validates the given input.

Parameters:
contentType - content type
content - textual content to validate
Throws:
InvalidContentException - if content is invalid
InvalidContentTypeException - if the content type is invalid
IOException - if content could not be read

getXMLReader

XMLReader getXMLReader(URL baseUrl,
                       String contentType)
                       throws SAXException
Gets an XML reader suitable for the given content type.

Parameters:
baseUrl - base URL for content, or null to omit
contentType - content type of input
Returns:
XML reader
Throws:
SAXException - if a SAX parsing error occurs

getXSLTemplates

Templates getXSLTemplates(String contentType)
Gets XSL templates for the given content type.

Parameters:
contentType - content type of input
Returns:
templates, or null if no transformation is to be done

getPrefix

String getPrefix(String contentType)
Gets the data to prepend to a content stream before processing.

Returns:
prefix data or null if none

getSuffix

String getSuffix(String contentType)
Gets the data to append to a content stream before processing.

Returns:
suffixs data or null if none


Copyright © 2006-2010 Craig Condit. All Rights Reserved.