com.google.enterprise.connector.spi

Class SocialUserProfileDocument

java.lang.Object

com.google.enterprise.connector.spi.SocialUserProfileDocument

All Implemented Interfaces:

Document

public class SocialUserProfileDocument
extends java.lang.Object
implements Document

A user profile document object.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocialUserProfileDocument.ColleagueData A colleague object.

Constructor Summary

Constructors

Constructor and Description
SocialUserProfileDocument(java.lang.String collectionName) Constructor takes collectionName as parameter for the user profile document.

Method Summary

Modifier and Type	Method and Description
Property	findProperty(java.lang.String name) Finds a Property by name.
java.util.List<Value>	getAskmeAbout() Gets topics user can be asked about.
java.util.List<SocialUserProfileDocument.ColleagueData>	getColleagues() Gets list of colleagues.
Value	getColleagueXml() Gets colleague list as XML of the form below:
Value	getOrgUrl() Gets organization URL of the user.
java.util.List<Value>	getPastProjects() Gets user's past projects.
Value	getPictureUrl() Gets URL of the profile picture.
java.util.List<Value>	getProperty(java.lang.String name) Gets a list of values for a property, the list may be null.
java.util.Set<java.lang.String>	getPropertyNames() Gets the set of names of all Properties in this Document.
boolean	getPublic() Gets whether profile is public.
java.util.List<Value>	getSkills() Gets skills of user.
Value	getUserContent() Gets user content which is typically a description of the user in his/her own words.
Value	getUserKey() Gets user's unique identity.
void	setAskmeAbout(java.util.List<java.lang.String> askmeAbout) Sets topics user can be asked about.
void	setColleagues(java.util.List<SocialUserProfileDocument.ColleagueData> colleagues) Sets list of colleagues of user.
void	setOrgUrl(java.lang.String orgUrl) Sets organization URL of the user.
void	setPastProjects(java.util.List<java.lang.String> values) Sets user's past projects.
void	setPictureUrl(java.lang.String pictureUrl) Sets URL of the profile picture of user.
void	setProperty(java.lang.String name, java.util.List<java.lang.String> values) Sets a list of values to a property (maybe beyond the distinguished properties).
void	setProperty(java.lang.String name, java.lang.String value) Sets a single value to a property.
void	setPublic(boolean isPublic) Sets whether the profile is public or not.
void	setSkills(java.util.List<java.lang.String> skillText) Sets skill set of user.
void	setUserContent(java.lang.String userContent) Sets user content: typically a description of user in own words.
void	setUserKey(java.lang.String userKey) Sets user's unique identity.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocialUserProfileDocument

public SocialUserProfileDocument(java.lang.String collectionName)

Constructor takes collectionName as parameter for the user profile document.

Parameters:

collectionName - name of collection where the profile document needs to go

Method Detail

getUserContent

public Value getUserContent()

Gets user content which is typically a description of the user in his/her own words.

Returns:

user content

setUserContent

public void setUserContent(java.lang.String userContent)

Sets user content: typically a description of user in own words.

Parameters:

userContent - user content

setSkills

public void setSkills(java.util.List<java.lang.String> skillText)

Sets skill set of user.

Parameters:

skillText - skills

getSkills

public java.util.List<Value> getSkills()

Gets skills of user.

Returns:

skills

setAskmeAbout

public void setAskmeAbout(java.util.List<java.lang.String> askmeAbout)

Sets topics user can be asked about.

Parameters:

askmeAbout - topics user can be asked about

getAskmeAbout

public java.util.List<Value> getAskmeAbout()

Gets topics user can be asked about.

Returns:

topics user can be asked about

setPastProjects

public void setPastProjects(java.util.List<java.lang.String> values)

Sets user's past projects.

Parameters:

values - projects user worked in the past

getPastProjects

public java.util.List<Value> getPastProjects()

Gets user's past projects.

Returns:

projects user worked in the past

setPublic

public void setPublic(boolean isPublic)

Sets whether the profile is public or not.

Parameters:

isPublic - true if the profile is public

getPublic

public boolean getPublic()

Gets whether profile is public.

Returns:

true if the profile is public

getUserKey

public Value getUserKey()

Gets user's unique identity.

Returns:

unique key identifying a user

setUserKey

public void setUserKey(java.lang.String userKey)

Sets user's unique identity.

Parameters:

userKey - unique key identifying a user

setProperty

public void setProperty(java.lang.String name,
                        java.util.List<java.lang.String> values)

Sets a list of values to a property (maybe beyond the distinguished properties).

Parameters:

name - name of user profile property

values - list of values of property

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Sets a single value to a property.

Parameters:

name - name of property

value - value of property

getProperty

public java.util.List<Value> getProperty(java.lang.String name)

Gets a list of values for a property, the list may be null.

Parameters:

name - name of property

Returns:

list of values: may be null

setPictureUrl

public void setPictureUrl(java.lang.String pictureUrl)

Sets URL of the profile picture of user.

Parameters:

pictureUrl - URL with the profile picture of user

getPictureUrl

public Value getPictureUrl()

Gets URL of the profile picture.

Returns:

: profile picture URL

setOrgUrl

public void setOrgUrl(java.lang.String orgUrl)

Sets organization URL of the user.

Parameters:

orgUrl - URL of user's organization

getOrgUrl

public Value getOrgUrl()

Gets organization URL of the user.

Returns:

URL of user's organization

setColleagues

public void setColleagues(java.util.List<SocialUserProfileDocument.ColleagueData> colleagues)
                   throws RepositoryException

Sets list of colleagues of user. This method serializes the list into XML according to Contacts.xsd.

Parameters:

colleagues - list of colleagues of user

Throws:

RepositoryException

getColleagues

public java.util.List<SocialUserProfileDocument.ColleagueData> getColleagues()

Gets list of colleagues.

Returns:

list of colleagues of user

getColleagueXml

public Value getColleagueXml()

Gets colleague list as XML of the form below:

  <?xml version="1.0" encoding="UTF-8"?>
       <gsa:Contacts xmlns:gsa="http://www.google.com/schemas/gsa"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <gsa:contact gsa:accountname="accountname" gsa:email="email"
         gsa:group="group" gsa:isinworkinggroup="true" gsa:name="name"
         gsa:title="mytitle" gsa:url="myurl"/>
       </gsa:Contacts> 
 

XSD for the XML is

  <?xml version="1.0" encoding="UTF-8"?>
       <schema xmlns="http://www.w3.org/2001/XMLSchema"
       targetNamespace="http://www.google.com/schemas/gsa"
         xmlns:gsa="http://www.google.com/schemas/gsa"
         elementFormDefault="qualified">
         <element name="Contacts">
           <complexType>
             <sequence>
               <element name="contact" maxOccurs="unbounded" minOccurs="1">
                 <complexType>
                   <attribute name="name" type="string" form="qualified"
                     use="optional" />
                   <attribute name="email" type="string" form="qualified" />
                   <attribute name="accountname" type="string" form="qualified"
                     use="required" />
                   <attribute name="url" type="string" form="qualified"
                     use="optional" />
                   <attribute name="title" type="string" form="qualified"
                     use="optional" />
                   <attribute name="group" type="string" form="qualified"
                     use="optional" />
                   <attribute name="isinworkinggroup" type="boolean"
                   form="qualified" use="optional" />
                 </complexType>
               </element>
             </sequence>
           </complexType>
         </element>
       </schema> 
 

Returns:

colleague list as XML

findProperty

public Property findProperty(java.lang.String name)

Finds a Property by name. If the current document has a property then that property is returned.

Specified by:

findProperty in interface Document

Parameters:

name - the name of the Property to find

Returns:

the Property, if found; null otherwise

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames()
                                                 throws RepositoryException

Gets the set of names of all Properties in this Document.

Specified by:

getPropertyNames in interface Document

Returns:

the names, as a Set of Strings

Throws:

RepositoryException - if a repository access error occurs

RepositoryDocumentException - if a document has fatal processing errors