com.sun.syndication.feed.module.sle
Class SimpleListExtensionImpl

java.lang.Object
  extended by com.sun.syndication.feed.module.ModuleImpl
      extended by com.sun.syndication.feed.module.sle.SimpleListExtensionImpl
All Implemented Interfaces:
com.sun.syndication.feed.CopyFrom, com.sun.syndication.feed.module.Module, SimpleListExtension, java.io.Serializable, java.lang.Cloneable

public class SimpleListExtensionImpl
extends com.sun.syndication.feed.module.ModuleImpl
implements SimpleListExtension

Author:
Robert "kebernet" Cooper
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.sun.syndication.feed.module.sle.SimpleListExtension
URI
 
Constructor Summary
SimpleListExtensionImpl()
          Creates a new instance of SimpleListExtensionImpl
 
Method Summary
 void copyFrom(java.lang.Object obj)
          Copies all the properties of the given bean into this one.
 Group[] getGroupFields()
          The cf:group element is intended to inform the client that the property to which it refers is one that is “groupableâ€? – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property.
 java.lang.Class getInterface()
          Returns the interface the copyFrom works on.
 Sort[] getSortFields()
          The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortableâ€? – that is, that the client should provide a user interface that allows the user to sort on that property.
 java.lang.String getTreatAs()
          This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list.
 java.lang.String getUri()
          Returns the URI of the module.
 void setGroupFields(Group[] groupFields)
          The cf:group element is intended to inform the client that the property to which it refers is one that is “groupableâ€? – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property.
 void setSortFields(Sort[] sortFields)
          The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortableâ€? – that is, that the client should provide a user interface that allows the user to sort on that property.
 void setTreatAs(java.lang.String treatAs)
          This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list.
 
Methods inherited from class com.sun.syndication.feed.module.ModuleImpl
clone, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sun.syndication.feed.module.Module
clone
 

Constructor Detail

SimpleListExtensionImpl

public SimpleListExtensionImpl()
Creates a new instance of SimpleListExtensionImpl

Method Detail

setGroupFields

public void setGroupFields(Group[] groupFields)
Description copied from interface: SimpleListExtension
The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable� – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of discrete values (e.g. book genres are perfect for groups).

Specified by:
setGroupFields in interface SimpleListExtension
Parameters:
groupFields - Array of types.Group objects.

getGroupFields

public Group[] getGroupFields()
Description copied from interface: SimpleListExtension
The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable� – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of discrete values (e.g. book genres are perfect for groups).

Specified by:
getGroupFields in interface SimpleListExtension
Returns:
Array of types.Group objects.

getInterface

public java.lang.Class getInterface()
Returns the interface the copyFrom works on.

This is useful when dealing with properties that may have multiple implementations. For example, Module.

Specified by:
getInterface in interface com.sun.syndication.feed.CopyFrom
Returns:
the interface the copyFrom works on.

setSortFields

public void setSortFields(Sort[] sortFields)
Description copied from interface: SimpleListExtension
The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable� – that is, that the client should provide a user interface that allows the user to sort on that property.

Specified by:
setSortFields in interface SimpleListExtension
Parameters:
sortFields - Array of types.Sort objects

getSortFields

public Sort[] getSortFields()
Description copied from interface: SimpleListExtension
The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable� – that is, that the client should provide a user interface that allows the user to sort on that property.

Specified by:
getSortFields in interface SimpleListExtension
Returns:
Array of types.Sort objects

setTreatAs

public void setTreatAs(java.lang.String treatAs)
Description copied from interface: SimpleListExtension
This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list. (defaults to "list" )

Specified by:
setTreatAs in interface SimpleListExtension
Parameters:
treatAs - treatAs value

getTreatAs

public java.lang.String getTreatAs()
Description copied from interface: SimpleListExtension
This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list.

Specified by:
getTreatAs in interface SimpleListExtension
Returns:
treatAs value.

getUri

public java.lang.String getUri()
Returns the URI of the module.

Specified by:
getUri in interface com.sun.syndication.feed.module.Module
Overrides:
getUri in class com.sun.syndication.feed.module.ModuleImpl
Returns:
URI of the module.

copyFrom

public void copyFrom(java.lang.Object obj)
Copies all the properties of the given bean into this one.

Any existing properties in this bean are lost.

This method is useful for moving from one implementation of a bean interface to another. For example from the default SyndFeed bean implementation to a Hibernate ready implementation.

Specified by:
copyFrom in interface com.sun.syndication.feed.CopyFrom
Parameters:
obj - the instance to copy properties from.


Copyright © 2006-2009. All Rights Reserved.