Package org.ametys.cms.search.cocoon

Class ContentResultSetHelper

java.lang.Object

org.ametys.cms.search.cocoon.ContentResultSetHelper

All Implemented Interfaces:

Component

public class ContentResultSetHelper
extends Object
implements Component

Helper to genrate SAX event for result of a search based on the requested result fields.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon Role.

Constructor Summary

Constructors

Constructor	Description
ContentResultSetHelper()

Method Summary

Modifier and Type	Method	Description
void	saxResultFields(ContentHandler contentHandler, Content content, Collection<? extends ResultField> fields, Locale defaultLocale)	Deprecated. use viewToSAX(ContentHandler, Content, View, Locale) instead
void	viewToSAX(ContentHandler contentHandler, Content content, View view, Locale defaultLocale)	Generates SAX events for the items in the content's view.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

Avalon Role.

Constructor Details

ContentResultSetHelper

public ContentResultSetHelper()

Method Details

viewToSAX

public void viewToSAX(ContentHandler contentHandler,
 Content content,
 View view,
 Locale defaultLocale)
               throws AmetysRepositoryException,
SAXException,
IOException

Generates SAX events for the items in the content's view. This method does not check rights.

Parameters:

contentHandler - the content handler where to SAX into.

content - the content.

view - the view.

defaultLocale - The locale to use to sax localized values such as multilingual content or multilingual string. Only to be valued if initial content's language is null, otherwise set this parameter to null.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

saxResultFields

@Deprecated
public void saxResultFields(ContentHandler contentHandler,
 Content content,
 Collection<? extends ResultField> fields,
 Locale defaultLocale)
                     throws AmetysRepositoryException,
SAXException,
IOException

Deprecated.

use viewToSAX(ContentHandler, Content, View, Locale) instead

Generates SAX events for the result fields of a content. This method does not check rights.

Parameters:

contentHandler - the content handler where to SAX into.

content - the content.

fields - the result fields.

defaultLocale - The locale to use to sax localized values such as multilingual content or multilingual string. Only to be valued if initial content's language is null, otherwise set this parameter to null.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.