org.rometools.feed.module.sle
Interface SleEntry

All Superinterfaces:

Cloneable, com.sun.syndication.feed.CopyFrom, com.sun.syndication.feed.module.Module, Serializable

All Known Implementing Classes:

SleEntryImpl

public interface SleEntry
extends com.sun.syndication.feed.module.Module

This is a parse only module that holds the values of enternal fields declared in the SLE module. These will not be persisted on an output() call, nor will changing a value here change a value in another module or a foreign markup tag.

Author:

Robert "kebernet" Cooper

Field Summary

static String

URI A bogus namespace used for temporarily storing values during parsing.

Method Summary

EntryValue	getGroupByElement(Group element) Returns an EntryValue for the given element name.
EntryValue[]	getGroupValues() An array of EntryValue objects that correspond to the grouping for the feed.
EntryValue	getSortByElement(Sort element) Returns an EntryValue for the given element name.
EntryValue[]	getSortValues() Returns an array of EntryValues for the fields declared in the heading.

Methods inherited from interface com.sun.syndication.feed.module.Module

clone, getUri

Methods inherited from interface com.sun.syndication.feed.CopyFrom

copyFrom, getInterface

Field Detail

URI

static final String URI

A bogus namespace used for temporarily storing values during parsing.

Method Detail

getGroupByElement

EntryValue getGroupByElement(Group element)

Returns an EntryValue for the given element name.

Parameters:

element - element name to look for

Returns:

Returns an EntryValue for the given element name.

getGroupValues

EntryValue[] getGroupValues()

An array of EntryValue objects that correspond to the grouping for the feed.

Returns:

An array of EntryValue objects that correspond to the grouping for the feed.

getSortByElement

EntryValue getSortByElement(Sort element)

Returns an EntryValue for the given element name.

Parameters:

element - element name

Returns:

Returns an EntryValue for the given element name.

getSortValues

EntryValue[] getSortValues()

Returns an array of EntryValues for the fields declared in the heading. NB:
Right now the parser will take any default=true field and change it to an integer value representing the default order in the field. You should not rely on these values data display to a user!

Returns:

Array of EntryValue implementations from this entry.