org.apache.lucene.gdata.data
Class ServerBaseEntry

java.lang.Object
  extended by org.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 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 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 ExtensionProfile has to be provided to the generation method.

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

Author:
Simon Willnauer
See Also:
ExtensionProfile, BaseFeed

Constructor Summary
ServerBaseEntry()
          Constructs a new ServerBaseEntry.
ServerBaseEntry(com.google.gdata.data.BaseEntry arg0)
           
 
Method Summary
 void addExtension(com.google.gdata.data.Extension arg0)
           
 void addHtmlLink(String arg0, String arg1, String arg2)
           
 void addLink(com.google.gdata.data.Link link)
           
 void addRepeatingExtension(com.google.gdata.data.Extension arg0)
           
 void declareExtensions(com.google.gdata.data.ExtensionProfile arg0)
           
 void generateAtom(com.google.gdata.util.common.xml.XmlWriter arg0, com.google.gdata.data.ExtensionProfile arg1)
           
 com.google.gdata.util.XmlBlob generateCumulativeXmlBlob(com.google.gdata.data.ExtensionProfile arg0)
           
 void generateRss(com.google.gdata.util.common.xml.XmlWriter arg0, com.google.gdata.data.ExtensionProfile arg1)
           
 List getAuthors()
           
 boolean getCanEdit()
           
 Set getCategories()
           
 com.google.gdata.data.Content getContent()
           
 List getContributors()
           
 com.google.gdata.data.Link getEditLink()
           
 com.google.gdata.data.BaseEntry getEntry()
           
 String getFeedId()
           
 com.google.gdata.data.Link getHtmlLink()
           
 String getId()
           
 com.google.gdata.data.Link getLink(String arg0, String arg1)
           
 List getLinks()
           
 com.google.gdata.data.DateTime getPublished()
           
<T extends com.google.gdata.data.Extension>
List<T>
getRepeatingExtension(Class<T> arg0)
           
 com.google.gdata.data.TextConstruct getRights()
           
 com.google.gdata.data.BaseEntry getSelf()
           
 com.google.gdata.data.Link getSelfLink()
           
 com.google.gdata.client.Service getService()
           
 ProvidedService getServiceConfig()
           
 String getServiceType()
           
 com.google.gdata.data.Source getSource()
           
 com.google.gdata.data.TextConstruct getSummary()
           
 com.google.gdata.data.TextConstruct getTitle()
           
 com.google.gdata.data.DateTime getUpdated()
           
 int getVersion()
           
 String getVersionId()
           
 com.google.gdata.util.XmlBlob getXmlBlob()
           
 boolean isDraft()
           
 void parseAtom(com.google.gdata.data.ExtensionProfile arg0, InputStream arg1)
           
 void parseAtom(com.google.gdata.data.ExtensionProfile arg0, Reader arg1)
           
 void parseCumulativeXmlBlob(com.google.gdata.util.XmlBlob arg0, com.google.gdata.data.ExtensionProfile arg1, Class arg2)
           
 void removeExtension(Class arg0)
           
 void removeExtension(com.google.gdata.data.Extension arg0)
           
 void removeRepeatingExtension(com.google.gdata.data.Extension arg0)
           
 void setCanEdit(boolean arg0)
           
 void setContent(com.google.gdata.data.Content arg0)
           
 void setContent(com.google.gdata.data.TextConstruct arg0)
           
 void setDraft(boolean arg0)
           
 void setEntry(com.google.gdata.data.BaseEntry entry)
           
 void setExtension(com.google.gdata.data.Extension arg0)
           
 void setFeedId(String feedId)
           
 void setId(String arg0)
           
 void setPublished(com.google.gdata.data.DateTime arg0)
           
 void setRights(com.google.gdata.data.TextConstruct arg0)
           
 void setService(com.google.gdata.client.Service arg0)
           
 void setServiceConfig(ProvidedService serviceConfig)
           
 void setSource(com.google.gdata.data.Source arg0)
           
 void setSummary(com.google.gdata.data.TextConstruct arg0)
           
 void setTitle(com.google.gdata.data.TextConstruct arg0)
           
 void setUpdated(com.google.gdata.data.DateTime arg0)
           
 void setVersion(int version)
           
 void setVersionId(String arg0)
           
 void setXmlBlob(com.google.gdata.util.XmlBlob arg0)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServerBaseEntry

public ServerBaseEntry()
Constructs a new ServerBaseEntry. To provide a concrete entry to decorate after object creation use setEntry(BaseEntry)


ServerBaseEntry

public ServerBaseEntry(com.google.gdata.data.BaseEntry arg0)
Parameters:
arg0 - - the source entry
Method Detail

getServiceConfig

public ProvidedService getServiceConfig()
Returns:
- the provided service for the source entry

setServiceConfig

public void setServiceConfig(ProvidedService serviceConfig)
Parameters:
serviceConfig - - the provided service for the source entry

getServiceType

public String getServiceType()
Returns:
- the name of the service related of the feed containing this entry

addLink

public void addLink(com.google.gdata.data.Link link)
Parameters:
link - - a link added to this entry

getFeedId

public String getFeedId()
Returns:
- the id of the owning feed

setFeedId

public void setFeedId(String feedId)
Parameters:
feedId - - the id of the owning feed

getEntry

public com.google.gdata.data.BaseEntry getEntry()
Returns:
- the decorated entry

setEntry

public void setEntry(com.google.gdata.data.BaseEntry entry)
Parameters:
entry - - the entry to decorate

addHtmlLink

public void addHtmlLink(String arg0,
                        String arg1,
                        String arg2)
See Also:
BaseEntry.addHtmlLink(java.lang.String, java.lang.String, java.lang.String)

generateAtom

public void generateAtom(com.google.gdata.util.common.xml.XmlWriter arg0,
                         com.google.gdata.data.ExtensionProfile arg1)
                  throws IOException
Throws:
IOException
See Also:
BaseEntry.generateAtom(com.google.gdata.util.common.xml.XmlWriter, com.google.gdata.data.ExtensionProfile)

generateRss

public void generateRss(com.google.gdata.util.common.xml.XmlWriter arg0,
                        com.google.gdata.data.ExtensionProfile arg1)
                 throws IOException
Throws:
IOException
See Also:
BaseEntry.generateRss(com.google.gdata.util.common.xml.XmlWriter, com.google.gdata.data.ExtensionProfile)

getAuthors

public List getAuthors()
See Also:
BaseEntry.getAuthors()

getCanEdit

public boolean getCanEdit()
See Also:
BaseEntry.getCanEdit()

getCategories

public Set getCategories()
See Also:
BaseEntry.getCategories()

getContent

public com.google.gdata.data.Content getContent()
See Also:
BaseEntry.getContent()

getContributors

public List getContributors()
See Also:
BaseEntry.getContributors()

getEditLink

public com.google.gdata.data.Link getEditLink()
See Also:
BaseEntry.getEditLink()

getHtmlLink

public com.google.gdata.data.Link getHtmlLink()
See Also:
BaseEntry.getHtmlLink()

getId

public String getId()
See Also:
BaseEntry.getId()

getLink

public com.google.gdata.data.Link getLink(String arg0,
                                          String arg1)
See Also:
BaseEntry.getLink(java.lang.String, java.lang.String)

getLinks

public List getLinks()
See Also:
BaseEntry.getLinks()

getPublished

public com.google.gdata.data.DateTime getPublished()
See Also:
BaseEntry.getPublished()

getRights

public com.google.gdata.data.TextConstruct getRights()
See Also:
BaseEntry.getRights()

getSelf

public com.google.gdata.data.BaseEntry getSelf()
                                        throws IOException,
                                               com.google.gdata.util.ServiceException
Throws:
IOException
com.google.gdata.util.ServiceException
See Also:
BaseEntry.getSelf()

getSelfLink

public com.google.gdata.data.Link getSelfLink()
See Also:
BaseEntry.getSelfLink()

getService

public com.google.gdata.client.Service getService()
See Also:
BaseEntry.getService()

getSource

public com.google.gdata.data.Source getSource()
See Also:
BaseEntry.getSource()

getSummary

public com.google.gdata.data.TextConstruct getSummary()
See Also:
BaseEntry.getSummary()

getTitle

public com.google.gdata.data.TextConstruct getTitle()
See Also:
BaseEntry.getTitle()

getUpdated

public com.google.gdata.data.DateTime getUpdated()
See Also:
BaseEntry.getUpdated()

getVersionId

public String getVersionId()
See Also:
BaseEntry.getVersionId()

isDraft

public boolean isDraft()
See Also:
BaseEntry.isDraft()

parseAtom

public void parseAtom(com.google.gdata.data.ExtensionProfile arg0,
                      InputStream arg1)
               throws IOException,
                      com.google.gdata.util.ParseException
Throws:
IOException
com.google.gdata.util.ParseException
See Also:
BaseEntry.parseAtom(com.google.gdata.data.ExtensionProfile, java.io.InputStream)

parseAtom

public void parseAtom(com.google.gdata.data.ExtensionProfile arg0,
                      Reader arg1)
               throws IOException,
                      com.google.gdata.util.ParseException
Throws:
IOException
com.google.gdata.util.ParseException
See Also:
BaseEntry.parseAtom(com.google.gdata.data.ExtensionProfile, java.io.Reader)

setCanEdit

public void setCanEdit(boolean arg0)
See Also:
BaseEntry.setCanEdit(boolean)

setContent

public void setContent(com.google.gdata.data.Content arg0)
See Also:
BaseEntry.setContent(com.google.gdata.data.Content)

setContent

public void setContent(com.google.gdata.data.TextConstruct arg0)
See Also:
BaseEntry.setContent(com.google.gdata.data.TextConstruct)

setDraft

public void setDraft(boolean arg0)
See Also:
BaseEntry.setDraft(boolean)

setId

public void setId(String arg0)
See Also:
BaseEntry.setId(java.lang.String)

setPublished

public void setPublished(com.google.gdata.data.DateTime arg0)
See Also:
BaseEntry.setPublished(com.google.gdata.data.DateTime)

setRights

public void setRights(com.google.gdata.data.TextConstruct arg0)
See Also:
BaseEntry.setRights(com.google.gdata.data.TextConstruct)

setService

public void setService(com.google.gdata.client.Service arg0)
See Also:
BaseEntry.setService(com.google.gdata.client.Service)

setSource

public void setSource(com.google.gdata.data.Source arg0)
See Also:
BaseEntry.setSource(com.google.gdata.data.Source)

setSummary

public void setSummary(com.google.gdata.data.TextConstruct arg0)
See Also:
BaseEntry.setSummary(com.google.gdata.data.TextConstruct)

setTitle

public void setTitle(com.google.gdata.data.TextConstruct arg0)
See Also:
BaseEntry.setTitle(com.google.gdata.data.TextConstruct)

setUpdated

public void setUpdated(com.google.gdata.data.DateTime arg0)
See Also:
BaseEntry.setUpdated(com.google.gdata.data.DateTime)

setVersionId

public void setVersionId(String arg0)
See Also:
BaseEntry.setVersionId(java.lang.String)

addExtension

public void addExtension(com.google.gdata.data.Extension arg0)
See Also:
ExtensionPoint.addExtension(com.google.gdata.data.Extension)

addRepeatingExtension

public void addRepeatingExtension(com.google.gdata.data.Extension arg0)
See Also:
ExtensionPoint.addRepeatingExtension(com.google.gdata.data.Extension)

generateCumulativeXmlBlob

public com.google.gdata.util.XmlBlob generateCumulativeXmlBlob(com.google.gdata.data.ExtensionProfile arg0)
                                                        throws IOException
Throws:
IOException
See Also:
ExtensionPoint.generateCumulativeXmlBlob(com.google.gdata.data.ExtensionProfile)

getRepeatingExtension

public <T extends com.google.gdata.data.Extension> List<T> getRepeatingExtension(Class<T> arg0)
See Also:
ExtensionPoint.getRepeatingExtension(java.lang.Class)

getXmlBlob

public com.google.gdata.util.XmlBlob getXmlBlob()
See Also:
ExtensionPoint.getXmlBlob()

parseCumulativeXmlBlob

public void parseCumulativeXmlBlob(com.google.gdata.util.XmlBlob arg0,
                                   com.google.gdata.data.ExtensionProfile arg1,
                                   Class arg2)
                            throws IOException,
                                   com.google.gdata.util.ParseException
Throws:
IOException
com.google.gdata.util.ParseException
See Also:
ExtensionPoint.parseCumulativeXmlBlob(com.google.gdata.util.XmlBlob, com.google.gdata.data.ExtensionProfile, java.lang.Class)

removeExtension

public void removeExtension(Class arg0)
See Also:
ExtensionPoint.removeExtension(java.lang.Class)

removeExtension

public void removeExtension(com.google.gdata.data.Extension arg0)
See Also:
ExtensionPoint.removeExtension(com.google.gdata.data.Extension)

removeRepeatingExtension

public void removeRepeatingExtension(com.google.gdata.data.Extension arg0)
See Also:
ExtensionPoint.removeRepeatingExtension(com.google.gdata.data.Extension)

setExtension

public void setExtension(com.google.gdata.data.Extension arg0)
See Also:
ExtensionPoint.setExtension(com.google.gdata.data.Extension)

setXmlBlob

public void setXmlBlob(com.google.gdata.util.XmlBlob arg0)
See Also:
ExtensionPoint.setXmlBlob(com.google.gdata.util.XmlBlob)

declareExtensions

public void declareExtensions(com.google.gdata.data.ExtensionProfile arg0)
See Also:
BaseEntry.declareExtensions(com.google.gdata.data.ExtensionProfile)

getVersion

public int getVersion()
Returns:
Returns the version.

setVersion

public void setVersion(int version)
Parameters:
version - The version to set.


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.