FileDocCategorySizeDatePackage
ServerBaseFeed.javaAPI DocApache Lucene 2.1.016837Wed Feb 14 10:46:06 GMT 2007org.apache.lucene.gdata.data

ServerBaseFeed

public class ServerBaseFeed extends Object
The GData-Server uses the GDATA-Client API for an interal representation of entries. These entities have dynamic elements like Links being generated using the requested URL.
Some components of the server also need additional infomation like the service type {@link org.apache.lucene.gdata.server.registry.ProvidedService} of the feed. All these information are encapsulated in the ServerBaseFeed decoration a concrete subl class of BaseFeed. The type of the {@link com.google.gdata.data.BaseEntry} contained it this feed will be passed to the ServerBaseFeed at creation time via the constructor. To retrieve the original entry call {@link ServerBaseFeed#getFeed()} returns a {@link com.google.gdata.data.BaseFeed} instance which can be casted into the actual type. To use the ServerBaseEntry for generation a provided format like RSS/ATOM the corresponding {@link com.google.gdata.data.ExtensionProfile} has to be provided to the generation method.
author
Simon Willnauer

Fields Summary
private String
serviceType
private org.apache.lucene.gdata.server.registry.ProvidedService
serviceConfig
private GDataAccount
account
private com.google.gdata.data.BaseFeed
feed
Constructors Summary
public ServerBaseFeed()
Creates a new ServerBaseFeed and decorates a basic instance of {@link Feed}

        this.feed = new Feed();
public ServerBaseFeed(com.google.gdata.data.BaseFeed feed)

param
feed - the feed to decorate

        this.feed = feed;
Methods Summary
public voidaddAuthor(com.google.gdata.data.Person person)

param
person - adds an author to the feed

        this.feed.getAuthors().add(person);
public voidaddExtension(com.google.gdata.data.Extension arg0)

see
com.google.gdata.data.ExtensionPoint#addExtension(com.google.gdata.data.Extension)

        
        this.feed.addExtension(arg0);
public voidaddHtmlLink(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2)

see
com.google.gdata.data.Source#addHtmlLink(java.lang.String, java.lang.String, java.lang.String)

        
        this.feed.addHtmlLink(arg0, arg1, arg2);
public voidaddLink(com.google.gdata.data.Link link)

param
link - a link added to the link list of the feed

        this.feed.getLinks().add(link);
public voidaddLinks(java.util.Collection collection)

param
collection - a collection of Link instance to be added to the feeds link list

        this.feed.getLinks().addAll(collection);
public voidaddRepeatingExtension(com.google.gdata.data.Extension arg0)

see
com.google.gdata.data.ExtensionPoint#addRepeatingExtension(com.google.gdata.data.Extension)

        
        this.feed.addRepeatingExtension(arg0);
public com.google.gdata.data.BaseEntrycreateEntry()

see
com.google.gdata.data.BaseFeed#createEntry()

        
        return this.feed.createEntry();
public voiddeclareExtensions(com.google.gdata.data.ExtensionProfile extProfile)

see
com.google.gdata.data.BaseFeed#declareExtensions(com.google.gdata.data.ExtensionProfile)


      this.feed.declareExtensions(extProfile);
public voidgenerateAtom(com.google.gdata.util.common.xml.XmlWriter arg0, com.google.gdata.data.ExtensionProfile arg1)

see
com.google.gdata.data.BaseFeed#generateAtom(com.google.gdata.util.common.xml.XmlWriter, com.google.gdata.data.ExtensionProfile)

        
        this.feed.generateAtom(arg0, arg1);
public voidgenerateAtomColl(com.google.gdata.util.common.xml.XmlWriter arg0)

see
com.google.gdata.data.BaseFeed#generateAtomColl(com.google.gdata.util.common.xml.XmlWriter)

        
        this.feed.generateAtomColl(arg0);
public voidgenerateRss(com.google.gdata.util.common.xml.XmlWriter arg0, com.google.gdata.data.ExtensionProfile arg1)

see
com.google.gdata.data.BaseFeed#generateRss(com.google.gdata.util.common.xml.XmlWriter, com.google.gdata.data.ExtensionProfile)

        
        this.feed.generateRss(arg0, arg1);
public GDataAccountgetAccount()

return
Returns the account.

        return this.account;
public java.util.ListgetAuthors()

see
com.google.gdata.data.Source#getAuthors()

        
        return this.feed.getAuthors();
public booleangetCanPost()

see
com.google.gdata.data.BaseFeed#getCanPost()

        
        return this.feed.getCanPost();
public java.util.SetgetCategories()

see
com.google.gdata.data.Source#getCategories()

        
        return this.feed.getCategories();
public java.util.ListgetContributors()

see
com.google.gdata.data.Source#getContributors()

        
        return this.feed.getContributors();
public java.util.ListgetEntries()

see
com.google.gdata.data.BaseFeed#getEntries()

        
        return this.feed.getEntries();
public com.google.gdata.data.LinkgetEntryPostLink()

see
com.google.gdata.data.BaseFeed#getEntryPostLink()

        
        return this.feed.getEntryPostLink();
public TgetExtension(java.lang.Class arg0)

see
com.google.gdata.data.ExtensionPoint#getExtension(java.lang.Class)

        
        return this.feed.getExtension(arg0);
public com.google.gdata.data.BaseFeedgetFeed()

return
Returns the feed.

        return this.feed;
public com.google.gdata.data.GeneratorgetGenerator()

see
com.google.gdata.data.Source#getGenerator()

        
        return this.feed.getGenerator();
public com.google.gdata.data.LinkgetHtmlLink()

see
com.google.gdata.data.Source#getHtmlLink()

        
        return this.feed.getHtmlLink();
public java.lang.StringgetIcon()

see
com.google.gdata.data.Source#getIcon()

        
        return this.feed.getIcon();
public java.lang.StringgetId()

see
com.google.gdata.data.Source#getId()

        
        return this.feed.getId();
public intgetItemsPerPage()

see
com.google.gdata.data.BaseFeed#getItemsPerPage()

        
        return this.feed.getItemsPerPage();
public com.google.gdata.data.LinkgetLink(java.lang.String arg0, java.lang.String arg1)

see
com.google.gdata.data.Source#getLink(java.lang.String, java.lang.String)

        
        return this.feed.getLink(arg0, arg1);
public java.util.ListgetLinks()

see
com.google.gdata.data.Source#getLinks()

        
        return this.feed.getLinks();
public java.lang.StringgetLogo()

see
com.google.gdata.data.Source#getLogo()

        
        return this.feed.getLogo();
public java.util.ListgetRepeatingExtension(java.lang.Class arg0)

see
com.google.gdata.data.ExtensionPoint#getRepeatingExtension(java.lang.Class)

        
        return this.feed.getRepeatingExtension(arg0);
public com.google.gdata.data.TextConstructgetRights()

see
com.google.gdata.data.Source#getRights()

        
        return this.feed.getRights();
public com.google.gdata.data.BaseFeedgetSelf()

see
com.google.gdata.data.BaseFeed#getSelf()

        
        return this.feed.getSelf();
public com.google.gdata.data.LinkgetSelfLink()

see
com.google.gdata.data.BaseFeed#getSelfLink()

        
        return this.feed.getSelfLink();
public com.google.gdata.client.ServicegetService()

see
com.google.gdata.data.BaseFeed#getService()

        
        return this.feed.getService();
public org.apache.lucene.gdata.server.registry.ProvidedServicegetServiceConfig()

return
- the provided service

        return this.serviceConfig;
public java.lang.StringgetServiceType()

return
- the name of the service related of the feed represented by this ServerBaseFeed

        return this.serviceType;
public intgetStartIndex()

see
com.google.gdata.data.BaseFeed#getStartIndex()

        
        return this.feed.getStartIndex();
public com.google.gdata.data.TextConstructgetSubtitle()

see
com.google.gdata.data.Source#getSubtitle()

        
        return this.feed.getSubtitle();
public com.google.gdata.data.TextConstructgetTitle()

see
com.google.gdata.data.Source#getTitle()

        
        return this.feed.getTitle();
public intgetTotalResults()

see
com.google.gdata.data.BaseFeed#getTotalResults()

        
        return this.feed.getTotalResults();
public com.google.gdata.data.DateTimegetUpdated()

see
com.google.gdata.data.Source#getUpdated()

        
        return this.feed.getUpdated();
public com.google.gdata.util.XmlBlobgetXmlBlob()

see
com.google.gdata.data.ExtensionPoint#getXmlBlob()

        
        return this.feed.getXmlBlob();
public com.google.gdata.data.BaseEntryinsert(com.google.gdata.data.BaseEntry arg0)

see
com.google.gdata.data.BaseFeed#insert(E)

        
        return this.feed.insert(arg0);
public voidparseAtom(com.google.gdata.data.ExtensionProfile arg0, java.io.InputStream arg1)

see
com.google.gdata.data.BaseFeed#parseAtom(com.google.gdata.data.ExtensionProfile, java.io.InputStream)

        
        this.feed.parseAtom(arg0, arg1);
public voidparseAtom(com.google.gdata.data.ExtensionProfile arg0, java.io.Reader arg1)

see
com.google.gdata.data.BaseFeed#parseAtom(com.google.gdata.data.ExtensionProfile, java.io.Reader)

        
        this.feed.parseAtom(arg0, arg1);
public voidparseCumulativeXmlBlob(com.google.gdata.util.XmlBlob arg0, com.google.gdata.data.ExtensionProfile arg1, java.lang.Class arg2)

see
com.google.gdata.data.ExtensionPoint#parseCumulativeXmlBlob(com.google.gdata.util.XmlBlob, com.google.gdata.data.ExtensionProfile, java.lang.Class)

        
        this.feed.parseCumulativeXmlBlob(arg0, arg1, arg2);
public voidremoveExtension(java.lang.Class arg0)

see
com.google.gdata.data.ExtensionPoint#removeExtension(java.lang.Class)

        
        this.feed.removeExtension(arg0);
public voidremoveExtension(com.google.gdata.data.Extension arg0)

see
com.google.gdata.data.ExtensionPoint#removeExtension(com.google.gdata.data.Extension)

        
        this.feed.removeExtension(arg0);
public voidremoveRepeatingExtension(com.google.gdata.data.Extension arg0)

see
com.google.gdata.data.ExtensionPoint#removeRepeatingExtension(com.google.gdata.data.Extension)

        
        this.feed.removeRepeatingExtension(arg0);
public voidsetAccount(GDataAccount account)

param
account The account to set.

        this.account = account;
public voidsetCanPost(boolean arg0)

see
com.google.gdata.data.BaseFeed#setCanPost(boolean)

        
        this.feed.setCanPost(arg0);
public voidsetExtension(com.google.gdata.data.Extension arg0)

see
com.google.gdata.data.ExtensionPoint#setExtension(com.google.gdata.data.Extension)

        
        this.feed.setExtension(arg0);
public voidsetFeed(com.google.gdata.data.BaseFeed feed)

param
feed The feed to set.

        this.feed = feed;
public voidsetGenerator(com.google.gdata.data.Generator arg0)

see
com.google.gdata.data.Source#setGenerator(com.google.gdata.data.Generator)

        
        this.feed.setGenerator(arg0);
public voidsetIcon(java.lang.String arg0)

see
com.google.gdata.data.Source#setIcon(java.lang.String)

        
        this.feed.setIcon(arg0);
public voidsetId(java.lang.String arg0)

see
com.google.gdata.data.Source#setId(java.lang.String)

        
        this.feed.setId(arg0);
public voidsetItemsPerPage(int arg0)

see
com.google.gdata.data.BaseFeed#setItemsPerPage(int)

        
        this.feed.setItemsPerPage(arg0);
public voidsetLogo(java.lang.String arg0)

see
com.google.gdata.data.Source#setLogo(java.lang.String)

        
        this.feed.setLogo(arg0);
public voidsetRights(com.google.gdata.data.TextConstruct arg0)

see
com.google.gdata.data.Source#setRights(com.google.gdata.data.TextConstruct)

        
        this.feed.setRights(arg0);
public voidsetService(com.google.gdata.client.Service arg0)

see
com.google.gdata.data.BaseFeed#setService(com.google.gdata.client.Service)

        
        this.feed.setService(arg0);
public voidsetServiceConfig(org.apache.lucene.gdata.server.registry.ProvidedService serviceConfig)

param
serviceConfig - - the provided service

        this.serviceConfig = serviceConfig;
        if (serviceConfig != null)
            this.serviceType = this.serviceConfig.getName();
public voidsetServiceType(java.lang.String serviceType)

param
serviceType - the name of the service related of the feed represented by this ServerBaseFeed

        this.serviceType = serviceType;
public voidsetStartIndex(int arg0)

see
com.google.gdata.data.BaseFeed#setStartIndex(int)

        
        this.feed.setStartIndex(arg0);
public voidsetSubtitle(com.google.gdata.data.TextConstruct arg0)

see
com.google.gdata.data.Source#setSubtitle(com.google.gdata.data.TextConstruct)

        
        this.feed.setSubtitle(arg0);
public voidsetTitle(com.google.gdata.data.TextConstruct arg0)

see
com.google.gdata.data.Source#setTitle(com.google.gdata.data.TextConstruct)

        
        this.feed.setTitle(arg0);
public voidsetTotalResults(int arg0)

see
com.google.gdata.data.BaseFeed#setTotalResults(int)

        
        this.feed.setTotalResults(arg0);
public voidsetUpdated(com.google.gdata.data.DateTime arg0)

see
com.google.gdata.data.Source#setUpdated(com.google.gdata.data.DateTime)

        
        this.feed.setUpdated(arg0);
public voidsetXmlBlob(com.google.gdata.util.XmlBlob arg0)

see
com.google.gdata.data.ExtensionPoint#setXmlBlob(com.google.gdata.util.XmlBlob)

        
        this.feed.setXmlBlob(arg0);