jgd.schemas.comapi
Class GDCOMIndexed

java.lang.Object
  extended by jgd.schemas.comapi.GDCOMIndexed
All Implemented Interfaces:
IJGDResultItem, ResultsType.ResultType, GoogleDesktopIndexable
Direct Known Subclasses:
GDCOMCalendar, GDCOMContact, GDCOMEmail, GDCOMFile, GDCOMIM, GDCOMJournal, GDCOMNote, GDCOMTask

public abstract class GDCOMIndexed
extends java.lang.Object
implements GoogleDesktopIndexable, IJGDResultItem

Author:
uf784048

Field Summary
private  java.lang.String schema
           
private  com.jacob.com.Variant searchResultEntryVariant
           
 
Constructor Summary
GDCOMIndexed(com.jacob.com.Variant searchResultEntryVariant, java.lang.String schema)
           
 
Method Summary
 java.lang.String get_content()
          Contains the content to be indexed.
 byte[] get_cookie_raw()
          Binary cookie.
 java.lang.String get_cookie()
          String cookie used to pass additional information identifying the event.
 byte[] get_extra_binary_data()
          Contains optional non-indexable binary metadata for this event
Required: No
 java.lang.String get_extra_data()
          Contains optional non-indexable string metadata for this event
Required: No
 java.lang.Byte get_format()
          Mime type of the indexable content, allowed values are text/plain and text/html.
 java.lang.Long get_native_size()
          Size of the indexable content in bytes.
 java.lang.String get_other_indexed_data()
          Contains optional indexable content and metadata.
 java.lang.String get_thumbnail_format()
          Mime type of the thumbnail image, allowed values are image/gif, image/jpeg, and image/png.
 byte[] get_thumbnail()
          Thumbnail image of the content.
 java.lang.String getCacheUrl()
          Deprecated. URL doesn't exists. Use getUrl() or get_content()
 java.lang.String getCategory()
          Deprecated. Use getSchema() method
 long getDocId()
          doc_id is the result's GDS internal identifier for doc.
 long getEventId()
          event_id is the result's GDS internal identifier for event.
 java.lang.String getFlags()
          Undocumented by google (Only for Desktop2)
 java.lang.String getFrom()
          from is the name of either the person an email message was from, or the other party in a Instant Message chat.
 java.lang.String getIcon()
          Deprecated.  
 long getId()
          id is the result's GDS internal identifier.
 java.lang.String getMessageId()
          Deprecated. Use other GoogleDesktopIndexed method.
protected  com.jacob.com.Variant getPropertyVariant(java.lang.String name)
           
protected  byte[] getPropertyVT_ARRAY(java.lang.String name)
           
protected  java.lang.Boolean getPropertyVT_BOOL(java.lang.String name)
           
protected  java.lang.String getPropertyVT_BSTR(java.lang.String name)
           
protected  java.util.Date getPropertyVT_DATE(java.lang.String name)
           
protected  java.lang.Byte getPropertyVT_UI2(java.lang.String name)
           
protected  java.lang.Integer getPropertyVT_UI4(java.lang.String name)
           
protected  java.lang.Long getPropertyVT_UI8(java.lang.String name)
           
 java.lang.String getSchema()
           
 java.lang.String getSnippet()
          snippet is a snippet from the result's content that contains at least one of the search terms.
 java.lang.String getThumbnail()
          Deprecated. Use get_thumbnail() method.
 java.math.BigInteger getTime()
          time is the time value from the event that put this content into GDS.
 java.util.Date getTimestamp()
           
 java.lang.String getTitle()
          Deprecated. Use any other method of GoogleDesktopIndexed
 java.lang.String getUrl()
          url is the result's URL.
 void setCacheUrl(java.lang.String value)
          cache_url is the Google Desktop Search-relative URL of this result's internal cache page.
 void setCategory(java.lang.String value)
          contains the result's type, one of: email, chat, web, file, contact, calendar, task, journal, note.
 void setDocId(long value)
          doc_id is the result's GDS internal identifier for doc.
 void setEventId(long value)
          event_id is the result's GDS internal identifier for event.
 void setFlags(java.lang.String value)
          Undocumented by google (Only for Desktop2)
 void setFrom(java.lang.String value)
          from is the name of either the person an email message was from, or the other party in a Instant Message chat.
 void setIcon(java.lang.String value)
          icon is a Google Desktop Search-relative URL to an icon representing this result or its type.
 void setId(long value)
          id is the result's GDS internal identifier.
 void setMessageId(java.lang.String value)
          Undocumented by google (Only for Desktop2)
 void setSnippet(java.lang.String value)
          snippet is a snippet from the result's content that contains at least one of the search terms.
 void setThumbnail(java.lang.String value)
          thumbnail is a relative URL to the icon for this result at the GDS webserver
 void setTime(java.math.BigInteger value)
          time is the time value from the event that put this content into GDS.
 void setTitle(java.lang.String value)
          title is the result's title, which varies depending on its type: Web page: the page's title.
 void setUrl(java.lang.String value)
          url is the result's URL.
 java.lang.String toString()
          Representation of an indexed element (schema and format )
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

searchResultEntryVariant

private com.jacob.com.Variant searchResultEntryVariant

schema

private java.lang.String schema
Constructor Detail

GDCOMIndexed

public GDCOMIndexed(com.jacob.com.Variant searchResultEntryVariant,
                    java.lang.String schema)
Method Detail

getPropertyVariant

protected com.jacob.com.Variant getPropertyVariant(java.lang.String name)

getPropertyVT_BSTR

protected java.lang.String getPropertyVT_BSTR(java.lang.String name)

getPropertyVT_UI2

protected java.lang.Byte getPropertyVT_UI2(java.lang.String name)

getPropertyVT_UI4

protected java.lang.Integer getPropertyVT_UI4(java.lang.String name)

getPropertyVT_UI8

protected java.lang.Long getPropertyVT_UI8(java.lang.String name)

getPropertyVT_DATE

protected java.util.Date getPropertyVT_DATE(java.lang.String name)

getPropertyVT_ARRAY

protected byte[] getPropertyVT_ARRAY(java.lang.String name)

getPropertyVT_BOOL

protected java.lang.Boolean getPropertyVT_BOOL(java.lang.String name)

get_content

public java.lang.String get_content()
Description copied from interface: GoogleDesktopIndexable
Contains the content to be indexed. The content must be in a text format (which can include HTML or similar markup, although GD will only treat HTML markup differently from plain text) not binary data. Note that some items may not have any indexable content, such as media files for which GD only indexes metadata and email messages with no content in their body. For those items, set this property to an empty string.
Required: Yes

Specified by:
get_content in interface GoogleDesktopIndexable
See Also:
GoogleDesktopIndexable.get_content()

get_format

public java.lang.Byte get_format()
Description copied from interface: GoogleDesktopIndexable
Mime type of the indexable content, allowed values are text/plain and text/html.
Required: Yes

Specified by:
get_format in interface GoogleDesktopIndexable
See Also:
GoogleDesktopIndexable.get_format()

get_native_size

public java.lang.Long get_native_size()
Description copied from interface: GoogleDesktopIndexable
Size of the indexable content in bytes. Note that for file types for which there is no indexable content but still contain content, such as media files, you should set this property to be the size of the content. For example, for a 10 Megabyte audio file, you wouldn't put the 10 MB of content in an event's content property, but you should set its native_size property to 10000000.
Required: No

Specified by:
get_native_size in interface GoogleDesktopIndexable
See Also:
()

get_thumbnail

public byte[] get_thumbnail()
Description copied from interface: GoogleDesktopIndexable
Thumbnail image of the content. We recommend the image be 109 pixels wide by 75 pixels tall. Image files of more than 20 KB will be rejected with an invalid argument error. If you specify a thumbnail image, you must also set a value for the following thumbnail_format property.
Required: No

Specified by:
get_thumbnail in interface GoogleDesktopIndexable
See Also:
GoogleDesktopIndexable.get_thumbnail()

get_thumbnail_format

public java.lang.String get_thumbnail_format()
Description copied from interface: GoogleDesktopIndexable
Mime type of the thumbnail image, allowed values are image/gif, image/jpeg, and image/png.
Required: No

Specified by:
get_thumbnail_format in interface GoogleDesktopIndexable
See Also:
()

get_cookie

public java.lang.String get_cookie()
Description copied from interface: GoogleDesktopIndexable
String cookie used to pass additional information identifying the event.
Required: No

Specified by:
get_cookie in interface GoogleDesktopIndexable
See Also:
GoogleDesktopIndexable.get_cookie()

get_cookie_raw

public byte[] get_cookie_raw()
Description copied from interface: GoogleDesktopIndexable
Binary cookie.
Required: No

Specified by:
get_cookie_raw in interface GoogleDesktopIndexable
See Also:
GoogleDesktopIndexable.get_cookie_raw()

get_other_indexed_data

public java.lang.String get_other_indexed_data()
Description copied from interface: GoogleDesktopIndexable
Contains optional indexable content and metadata. Can be used to index additional data that is separate from the content property
Required: No

Specified by:
get_other_indexed_data in interface GoogleDesktopIndexable
See Also:
(New)()

get_extra_data

public java.lang.String get_extra_data()
Description copied from interface: GoogleDesktopIndexable
Contains optional non-indexable string metadata for this event
Required: No

Specified by:
get_extra_data in interface GoogleDesktopIndexable
See Also:
(New)()

get_extra_binary_data

public byte[] get_extra_binary_data()
Description copied from interface: GoogleDesktopIndexable
Contains optional non-indexable binary metadata for this event
Required: No

Specified by:
get_extra_binary_data in interface GoogleDesktopIndexable
See Also:
(New)()

toString

public java.lang.String toString()
Representation of an indexed element (schema and format )

Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

getSchema

public java.lang.String getSchema()
Specified by:
getSchema in interface IJGDResultItem

getTimestamp

public java.util.Date getTimestamp()
Specified by:
getTimestamp in interface IJGDResultItem

getCacheUrl

public java.lang.String getCacheUrl()
Deprecated. URL doesn't exists. Use getUrl() or get_content()

This URL doesn't exists. Now this method returns the real URL of Item.

Specified by:
getCacheUrl in interface ResultsType.ResultType
Returns:
URL of GD item

getCategory

public java.lang.String getCategory()
Deprecated. Use getSchema() method

Description copied from interface: ResultsType.ResultType
contains the result's type, one of: email, chat, web, file, contact, calendar, task, journal, note.

Specified by:
getCategory in interface ResultsType.ResultType
Returns:
possible object is String
See Also:
ResultsType.ResultType.getCategory()

getDocId

public long getDocId()
Description copied from interface: ResultsType.ResultType
doc_id is the result's GDS internal identifier for doc. (Only for Desktop2)

Specified by:
getDocId in interface ResultsType.ResultType

getEventId

public long getEventId()
Description copied from interface: ResultsType.ResultType
event_id is the result's GDS internal identifier for event. (Only for Desktop2)

Specified by:
getEventId in interface ResultsType.ResultType

getFlags

public java.lang.String getFlags()
Description copied from interface: ResultsType.ResultType
Undocumented by google (Only for Desktop2)

Specified by:
getFlags in interface ResultsType.ResultType
Returns:
possible object is String

getFrom

public java.lang.String getFrom()
Description copied from interface: ResultsType.ResultType
from is the name of either the person an email message was from, or the other party in a Instant Message chat.

Specified by:
getFrom in interface ResultsType.ResultType
Returns:
possible object is String

getIcon

public java.lang.String getIcon()
Deprecated. 

Description copied from interface: ResultsType.ResultType
icon is a Google Desktop Search-relative URL to an icon representing this result or its type. This will either be one of the standard Google Desktop Search result type icons (envelope for email, Word icon for a Word file, etc.) or a favicon obtained from a website.

Specified by:
getIcon in interface ResultsType.ResultType
Returns:
possible object is String

getId

public long getId()
Description copied from interface: ResultsType.ResultType
id is the result's GDS internal identifier.

Specified by:
getId in interface ResultsType.ResultType

getMessageId

public java.lang.String getMessageId()
Deprecated. Use other GoogleDesktopIndexed method.

Now this method returns getId() value

Specified by:
getMessageId in interface ResultsType.ResultType
Returns:
possible object is String

getThumbnail

public java.lang.String getThumbnail()
Deprecated. Use get_thumbnail() method.

Now this method returns empty URL

Specified by:
getThumbnail in interface ResultsType.ResultType
Returns:
possible object is String

getTime

public java.math.BigInteger getTime()
Description copied from interface: ResultsType.ResultType
time is the time value from the event that put this content into GDS. Usually this will be the time the content was indexed by GDS, but, for example, it could also be a file's last modified time. The format is per the Windows FILETIME structure; the number of 100-nanosecond intervals since January 1, 1601 represented as a 64-bit number.

Specified by:
getTime in interface ResultsType.ResultType
Returns:
possible object is BigInteger

getTitle

public java.lang.String getTitle()
Deprecated. Use any other method of GoogleDesktopIndexed

Now this method returns string representing of GD item.

Specified by:
getTitle in interface ResultsType.ResultType
Returns:
possible object is String

getUrl

public java.lang.String getUrl()
Description copied from interface: ResultsType.ResultType
url is the result's URL. For files and web pages, this is the usual path to the result. For chats and email messages, Google Desktop Search generates a URL for the location where it has stored its cached copy.

Specified by:
getUrl in interface ResultsType.ResultType
Returns:
possible object is String

getSnippet

public java.lang.String getSnippet()
Description copied from interface: ResultsType.ResultType
snippet is a snippet from the result's content that contains at least one of the search terms.

Specified by:
getSnippet in interface ResultsType.ResultType
Returns:
possible object is String

setSnippet

public void setSnippet(java.lang.String value)
Description copied from interface: ResultsType.ResultType
snippet is a snippet from the result's content that contains at least one of the search terms.

Specified by:
setSnippet in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setCacheUrl

public void setCacheUrl(java.lang.String value)
Description copied from interface: ResultsType.ResultType
cache_url is the Google Desktop Search-relative URL of this result's internal cache page.

Specified by:
setCacheUrl in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setCategory

public void setCategory(java.lang.String value)
Description copied from interface: ResultsType.ResultType
contains the result's type, one of: email, chat, web, file, contact, calendar, task, journal, note.

Specified by:
setCategory in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setDocId

public void setDocId(long value)
Description copied from interface: ResultsType.ResultType
doc_id is the result's GDS internal identifier for doc. (Only for Desktop2)

Specified by:
setDocId in interface ResultsType.ResultType

setEventId

public void setEventId(long value)
Description copied from interface: ResultsType.ResultType
event_id is the result's GDS internal identifier for event. (Only for Desktop2)

Specified by:
setEventId in interface ResultsType.ResultType

setFlags

public void setFlags(java.lang.String value)
Description copied from interface: ResultsType.ResultType
Undocumented by google (Only for Desktop2)

Specified by:
setFlags in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setFrom

public void setFrom(java.lang.String value)
Description copied from interface: ResultsType.ResultType
from is the name of either the person an email message was from, or the other party in a Instant Message chat.

Specified by:
setFrom in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setIcon

public void setIcon(java.lang.String value)
Description copied from interface: ResultsType.ResultType
icon is a Google Desktop Search-relative URL to an icon representing this result or its type. This will either be one of the standard Google Desktop Search result type icons (envelope for email, Word icon for a Word file, etc.) or a favicon obtained from a website.

Specified by:
setIcon in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setId

public void setId(long value)
Description copied from interface: ResultsType.ResultType
id is the result's GDS internal identifier.

Specified by:
setId in interface ResultsType.ResultType

setMessageId

public void setMessageId(java.lang.String value)
Description copied from interface: ResultsType.ResultType
Undocumented by google (Only for Desktop2)

Specified by:
setMessageId in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setThumbnail

public void setThumbnail(java.lang.String value)
Description copied from interface: ResultsType.ResultType
thumbnail is a relative URL to the icon for this result at the GDS webserver

Specified by:
setThumbnail in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setTime

public void setTime(java.math.BigInteger value)
Description copied from interface: ResultsType.ResultType
time is the time value from the event that put this content into GDS. Usually this will be the time the content was indexed by GDS, but, for example, it could also be a file's last modified time. The format is per the Windows FILETIME structure; the number of 100-nanosecond intervals since January 1, 1601 represented as a 64-bit number.

Specified by:
setTime in interface ResultsType.ResultType
Parameters:
value - allowed object is BigInteger

setTitle

public void setTitle(java.lang.String value)
Description copied from interface: ResultsType.ResultType
title is the result's title, which varies depending on its type: Web page: the page's title. Email: the message's Subject:. File: its filename. Chat: a line from the chat.

Specified by:
setTitle in interface ResultsType.ResultType
Parameters:
value - allowed object is String

setUrl

public void setUrl(java.lang.String value)
Description copied from interface: ResultsType.ResultType
url is the result's URL. For files and web pages, this is the usual path to the result. For chats and email messages, Google Desktop Search generates a URL for the location where it has stored its cached copy.

Specified by:
setUrl in interface ResultsType.ResultType
Parameters:
value - allowed object is String


Copyright 2007