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

ServerBaseEntry

public class ServerBaseEntry 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 entry and the feedid a entry belongs to. All these information are encapsulated in the ServerBaseEntry decorating a concrete sub class of BaseEntry. The actual {@link com.google.gdata.data.BaseEntry} will be passed to the ServerBaseEntry at creation time via the constructor. To use the ServerBaseFeed for generation a provided format like RSS/ATOM the corresponding {@link com.google.gdata.data.ExtensionProfile} has to be provided to the generation method.

For a general overview of the generic BaseFeed class see the gdata-client API documentation

see
com.google.gdata.data.ExtensionProfile
see
com.google.gdata.data.BaseFeed
author
Simon Willnauer

Fields Summary
private String
feedId
private String
serviceType
private org.apache.lucene.gdata.server.registry.ProvidedService
serviceConfig
private com.google.gdata.data.BaseEntry
entry
private static final int
DEFAULTVERSION
private int
version
Constructors Summary
public ServerBaseEntry()
Constructs a new ServerBaseEntry. To provide a concrete entry to decorate after object creation use {@link ServerBaseEntry#setEntry(BaseEntry)}

        this(new Entry());
public ServerBaseEntry(com.google.gdata.data.BaseEntry arg0)

param
arg0 - the source entry

        this.entry = arg0;
        this.setVersion(DEFAULTVERSION);
Methods Summary
public voidaddExtension(com.google.gdata.data.Extension arg0)

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

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

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

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

param
link - a link added to this entry

        this.entry.getLinks().add(link);
public voidaddRepeatingExtension(com.google.gdata.data.Extension arg0)

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

        
        this.entry.addRepeatingExtension(arg0);
public voiddeclareExtensions(com.google.gdata.data.ExtensionProfile arg0)

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

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

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

        
        this.entry.generateAtom(arg0, arg1);
public com.google.gdata.util.XmlBlobgenerateCumulativeXmlBlob(com.google.gdata.data.ExtensionProfile arg0)

see
com.google.gdata.data.ExtensionPoint#generateCumulativeXmlBlob(com.google.gdata.data.ExtensionProfile)

        
        return this.entry.generateCumulativeXmlBlob(arg0);
public voidgenerateRss(com.google.gdata.util.common.xml.XmlWriter arg0, com.google.gdata.data.ExtensionProfile arg1)

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

        
        this.entry.generateRss(arg0, arg1);
public java.util.ListgetAuthors()

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

        
        return this.entry.getAuthors();
public booleangetCanEdit()

see
com.google.gdata.data.BaseEntry#getCanEdit()

        
        return this.entry.getCanEdit();
public java.util.SetgetCategories()

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

        
        return this.entry.getCategories();
public com.google.gdata.data.ContentgetContent()

see
com.google.gdata.data.BaseEntry#getContent()

        
        return this.entry.getContent();
public java.util.ListgetContributors()

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

        
        return this.entry.getContributors();
public com.google.gdata.data.LinkgetEditLink()

see
com.google.gdata.data.BaseEntry#getEditLink()

        
        return this.entry.getEditLink();
public com.google.gdata.data.BaseEntrygetEntry()

return
- the decorated entry

        return this.entry;
public java.lang.StringgetFeedId()

return
- the id of the owning feed

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

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

        
        return this.entry.getHtmlLink();
public java.lang.StringgetId()

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

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

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

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

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

        
        return this.entry.getLinks();
public com.google.gdata.data.DateTimegetPublished()

see
com.google.gdata.data.BaseEntry#getPublished()

        
        return this.entry.getPublished();
public java.util.ListgetRepeatingExtension(java.lang.Class arg0)

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

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

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

        
        return this.entry.getRights();
public com.google.gdata.data.BaseEntrygetSelf()

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

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

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

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

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

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

return
- the provided service for the source entry


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

return
- the name of the service related of the feed containing this entry

        return this.serviceType;
public com.google.gdata.data.SourcegetSource()

see
com.google.gdata.data.BaseEntry#getSource()

        
        return this.entry.getSource();
public com.google.gdata.data.TextConstructgetSummary()

see
com.google.gdata.data.BaseEntry#getSummary()

        
        return this.entry.getSummary();
public com.google.gdata.data.TextConstructgetTitle()

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

        
        return this.entry.getTitle();
public com.google.gdata.data.DateTimegetUpdated()

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

        
        return this.entry.getUpdated();
public intgetVersion()

return
Returns the version.

        return this.version;
public java.lang.StringgetVersionId()

see
com.google.gdata.data.BaseEntry#getVersionId()

        
        return this.entry.getVersionId();
public com.google.gdata.util.XmlBlobgetXmlBlob()

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

        
        return this.entry.getXmlBlob();
public booleanisDraft()

see
com.google.gdata.data.BaseEntry#isDraft()

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

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

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

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

        
        this.entry.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.entry.parseCumulativeXmlBlob(arg0, arg1, arg2);
public voidremoveExtension(java.lang.Class arg0)

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

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

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

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

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

        
        this.entry.removeRepeatingExtension(arg0);
public voidsetCanEdit(boolean arg0)

see
com.google.gdata.data.BaseEntry#setCanEdit(boolean)

        
        this.entry.setCanEdit(arg0);
public voidsetContent(com.google.gdata.data.Content arg0)

see
com.google.gdata.data.BaseEntry#setContent(com.google.gdata.data.Content)

        
        this.entry.setContent(arg0);
public voidsetContent(com.google.gdata.data.TextConstruct arg0)

see
com.google.gdata.data.BaseEntry#setContent(com.google.gdata.data.TextConstruct)

        
        this.entry.setContent(arg0);
public voidsetDraft(boolean arg0)

see
com.google.gdata.data.BaseEntry#setDraft(boolean)

        
        this.entry.setDraft(arg0);
public voidsetEntry(com.google.gdata.data.BaseEntry entry)

param
entry - the entry to decorate

        this.entry = entry;
public voidsetExtension(com.google.gdata.data.Extension arg0)

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

        
        this.entry.setExtension(arg0);
public voidsetFeedId(java.lang.String feedId)

param
feedId - the id of the owning feed

        this.feedId = feedId;
public voidsetId(java.lang.String arg0)

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

        
        this.entry.setId(arg0);
public voidsetPublished(com.google.gdata.data.DateTime arg0)

see
com.google.gdata.data.BaseEntry#setPublished(com.google.gdata.data.DateTime)

        
        this.entry.setPublished(arg0);
public voidsetRights(com.google.gdata.data.TextConstruct arg0)

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

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

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

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

param
serviceConfig - the provided service for the source entry

        this.serviceConfig = serviceConfig;
        if (serviceConfig != null)
            this.serviceType = serviceConfig.getName();
public voidsetSource(com.google.gdata.data.Source arg0)

see
com.google.gdata.data.BaseEntry#setSource(com.google.gdata.data.Source)

        
        this.entry.setSource(arg0);
public voidsetSummary(com.google.gdata.data.TextConstruct arg0)

see
com.google.gdata.data.BaseEntry#setSummary(com.google.gdata.data.TextConstruct)

        
        this.entry.setSummary(arg0);
public voidsetTitle(com.google.gdata.data.TextConstruct arg0)

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

        
        this.entry.setTitle(arg0);
public voidsetUpdated(com.google.gdata.data.DateTime arg0)

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

        
        this.entry.setUpdated(arg0);
public voidsetVersion(int version)

param
version The version to set.

        if(version < this.version)
            throw new IllegalArgumentException("Version must be greater than the current version -- current version: "+this.version);
        this.version = version;
        setVersionId(""+this.version);
public voidsetVersionId(java.lang.String arg0)

see
com.google.gdata.data.BaseEntry#setVersionId(java.lang.String)

        
        this.entry.setVersionId(arg0);
public voidsetXmlBlob(com.google.gdata.util.XmlBlob arg0)

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

        
        this.entry.setXmlBlob(arg0);