com.jivesoftware.community.importer
Interface ImportSource

public interface ImportSource

An import source is used by the importers extending the BaseImporter to source the information required for importing content into Clearspace.

Method Summary

void	destroy() Called to destroy the import source.
java.lang.Iterable<com.jivesoftware.community.importer.beans.AbuseImportBean>	getAbuse() Returns an iterable of abuse import beans corresponding to the aubse reports to be imported
int	getAbuseCount() Returns a count of abuse reports to be imported
int	getAnnouncementCount(com.jivesoftware.community.importer.beans.CommunityImportBean community) Returns a count of announcements to be imported in the given community
java.lang.Iterable<com.jivesoftware.community.importer.beans.AnnouncementImportBean>	getAnnouncements(com.jivesoftware.community.importer.beans.CommunityImportBean community) Returns an iterable of announcement import beans corresponding to annnouncements in the given parent community
int	getAttachmentCount(com.jivesoftware.community.importer.beans.ID id) Returns a count of attachments to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.AttachmentImportBean>	getAttachments(com.jivesoftware.community.importer.beans.ID id) Returns an iterable of attachment import beans corresponding to the attachments for the given ID
int	getAvatarCount() Returns a count of avatars to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.AvatarImportBean>	getAvatars() Returns an iterable of avatar import beans corresponding to the avatars to be imported
int	getBanCount() Returns a count of bans to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.BanImportBean>	getBans() Returns an iterable of ban import beans corresponding to the bans to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.CommunityImportBean>	getBaseCommunities() Returns an iterable of community import beans corresponding to the first child level of communities beneath the root level community.
int	getCommunityCount() Returns a count of communities to be imported
java.lang.Iterable<com.jivesoftware.community.importer.ImportTask>	getCompletionTasks() Returns an iterable of ImportTasks that should be run after the rest of the import is complete.
int	getDocumentCount(com.jivesoftware.community.importer.beans.CommunityImportBean community) Returns a count of documents to be imported in the given community
java.lang.Iterable<com.jivesoftware.community.importer.beans.DocumentImportBean>	getDocuments(com.jivesoftware.community.importer.beans.CommunityImportBean community) Returns an iterable of document import beans corresponding to the child documents of the given parent community
int	getForumThreadCount(com.jivesoftware.community.importer.beans.CommunityImportBean community) Returns a count of forum threads to be imported in the given community
java.lang.Iterable<com.jivesoftware.community.importer.beans.ForumThreadImportBean>	getForumThreads(com.jivesoftware.community.importer.beans.CommunityImportBean community) Returns an iterable of forum thread import beans corresponding to child threads of the given parent community
int	getGatewayCount() Returns a count of gateways to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.GatewayImportBean>	getGateways() Returns an iterable of gateway import beans corresponding to the gateways to be imported
int	getGroupCount() Returns a count of groups to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.GroupImportBean>	getGroups() Returns an iterable of group import beans corresponding to the groups to be imported
int	getImageCount(com.jivesoftware.community.importer.beans.ID id) Returns a count of images to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.ImageImportBean>	getImages(com.jivesoftware.community.importer.beans.ID id) Returns an iterable of image import beans corresponding to the images for the given ID
long	getMaxForumMessageID() Returns the maximum ID for forum messages being imported.
long	getMaxForumThreadID() Returns the maximum ID for forum threads being imported.
int	getPermissionCount(com.jivesoftware.community.importer.beans.ID id) Returns a count of permissions to be imported for the given ID
com.jivesoftware.community.importer.beans.PermissionsImportBean	getPermissions(com.jivesoftware.community.importer.beans.ID id) Returns the permission import bean corresponding to the given ID
int	getPollCount(com.jivesoftware.community.importer.beans.ID id) Returns a count of polls to be imported for the given ID
java.lang.Iterable<com.jivesoftware.community.importer.beans.PollImportBean>	getPolls(com.jivesoftware.community.importer.beans.ID id) Returns an iterable of poll import beans corresponding to the polls in the given ID
java.lang.Iterable<com.jivesoftware.community.importer.beans.PrivateMessageFolderImportBean>	getPrivateMessageFolders(com.jivesoftware.community.importer.beans.ID id) Returns an iterable of private message folder import beans corresponding to the private message folders for the given user
int	getProfileFieldCount() Returns a count of profile fields to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.ProfileFieldImportBean>	getProfileFields() Returns an iterable of profile field import beans corresponding to the profile fields to be imported
int	getQuestionAnswerCount() Returns a count of all the question answer data in the system
java.lang.Iterable<com.jivesoftware.community.importer.beans.QuestionAnswerImportBean>	getQuestionAnswers() Returns all the question answer data
int	getRatingCount(com.jivesoftware.community.importer.beans.ID id) Returns a count of ratings to be imported for the given ID
java.lang.Iterable<com.jivesoftware.community.importer.beans.RatingImportBean>	getRatings(com.jivesoftware.community.importer.beans.ID id) Returns an iterable of rating import beans corresponding to the ratings to be imported in the given ID
int	getRatingTypeCount() Returns a count of rating types to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.RatingTypeImportBean>	getRatingTypes() Returns an iterable of rating type import beans corresponding to the rating types to be imported
int	getStatusLevelCorrectPoints() Correct answer points.
int	getStatusLevelCount() Returns a count of status levels to be imported
int	getStatusLevelHelpfulPoints() Helpful answer points.
java.lang.Iterable<com.jivesoftware.community.importer.beans.StatusLevelPointImportBean>	getStatusLevelPointsForCommunity(com.jivesoftware.community.importer.beans.ID communityID) Returns status levels points for a particular community.
java.lang.Iterable<com.jivesoftware.community.importer.beans.StatusLevelImportBean>	getStatusLevels() Returns an iterable of status level import beans corresponding to the status levels to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.CommunityImportBean>	getSubCommunities(com.jivesoftware.community.importer.beans.CommunityImportBean community) Returns an iterable of community import beans corresponding to the sub communities of the given parent community
java.util.Map<java.lang.String,java.lang.String>	getSystemProperties() Returns a map of system properties to be imported
java.lang.Iterable<java.lang.String>	getTags(com.jivesoftware.community.importer.beans.ID id) Returns an iterable of tags for the given ID
int	getUserCount() Returns a count of users to be imported
java.util.Map<com.jivesoftware.community.importer.beans.ID,java.util.Map<java.lang.String,java.lang.String>>	getUserProperties() Returns a map of properties for users.
java.lang.Iterable<com.jivesoftware.community.importer.beans.UserImportBean>	getUsers() Returns an iterable of user import beans corresponding to the users to be imported
int	getViewCountCount() Returns the count of all the view counts
java.lang.Iterable<com.jivesoftware.community.importer.beans.ViewCountImportBean>	getViewCounts() Returns all the view counts
int	getWatchCount() Returns a count of watches to be imported
java.lang.Iterable<com.jivesoftware.community.importer.beans.WatchImportBean>	getWatches() Returns an iterable of watch import beans corresponding to the watches to be imported
boolean	hasPrivateMessages() Returns a system level check to see if there any private messages at all.
void	init(com.jivesoftware.community.importer.ImportConfiguration conf) Called to initialize the import source

Method Detail

init

void init(com.jivesoftware.community.importer.ImportConfiguration conf)

Called to initialize the import source

Parameters:

conf - the import configuration to initialize with

destroy

void destroy()

Called to destroy the import source. Import sources should cleanup any long lived resources such as database connections when this method is called.

getBaseCommunities

java.lang.Iterable<com.jivesoftware.community.importer.beans.CommunityImportBean> getBaseCommunities()

Returns an iterable of community import beans corresponding to the first child level of communities beneath the root level community.

Returns:

an iterable of community import beans

getUserCount

int getUserCount()

Returns a count of users to be imported

Returns:

a count of users to be imported

getUsers

java.lang.Iterable<com.jivesoftware.community.importer.beans.UserImportBean> getUsers()

Returns an iterable of user import beans corresponding to the users to be imported

Returns:

an iterable of user import beans

getUserProperties

java.util.Map<com.jivesoftware.community.importer.beans.ID,java.util.Map<java.lang.String,java.lang.String>> getUserProperties()

Returns a map of properties for users. This is used when the importer is configured to not import users but is configured to import those user's properties.

Returns:

a map of ID -> Map of properties

getGroupCount

int getGroupCount()

Returns a count of groups to be imported

Returns:

a count of groups to be imported

getGroups

java.lang.Iterable<com.jivesoftware.community.importer.beans.GroupImportBean> getGroups()

Returns an iterable of group import beans corresponding to the groups to be imported

Returns:

an iterable of group import beans

getProfileFieldCount

int getProfileFieldCount()

Returns a count of profile fields to be imported

Returns:

a count of profile fields to be imported

getProfileFields

java.lang.Iterable<com.jivesoftware.community.importer.beans.ProfileFieldImportBean> getProfileFields()

Returns an iterable of profile field import beans corresponding to the profile fields to be imported

Returns:

an iterable of profile field import beans

getCommunityCount

int getCommunityCount()

Returns a count of communities to be imported

Returns:

a count of communities to be imported

getSubCommunities

java.lang.Iterable<com.jivesoftware.community.importer.beans.CommunityImportBean> getSubCommunities(com.jivesoftware.community.importer.beans.CommunityImportBean community)

Returns an iterable of community import beans corresponding to the sub communities of the given parent community

Parameters:

community - the parent community

Returns:

an iterable of community import beans

getMaxForumThreadID

long getMaxForumThreadID()

Returns the maximum ID for forum threads being imported.

Returns:

the maximum ID for forum threads being imported.

getMaxForumMessageID

long getMaxForumMessageID()

Returns the maximum ID for forum messages being imported.

Returns:

the maximum ID for forum messages being imported.

getForumThreadCount

int getForumThreadCount(com.jivesoftware.community.importer.beans.CommunityImportBean community)

Returns a count of forum threads to be imported in the given community

Parameters:

community - the parent community

Returns:

a count of forum threads to be imported

getForumThreads

java.lang.Iterable<com.jivesoftware.community.importer.beans.ForumThreadImportBean> getForumThreads(com.jivesoftware.community.importer.beans.CommunityImportBean community)

Returns an iterable of forum thread import beans corresponding to child threads of the given parent community

Parameters:

community - the parent community

Returns:

an iterable of forum thread import beans

getDocumentCount

int getDocumentCount(com.jivesoftware.community.importer.beans.CommunityImportBean community)

Returns a count of documents to be imported in the given community

Parameters:

community - the parent community

Returns:

a count of documents to be imported

getDocuments

java.lang.Iterable<com.jivesoftware.community.importer.beans.DocumentImportBean> getDocuments(com.jivesoftware.community.importer.beans.CommunityImportBean community)

Returns an iterable of document import beans corresponding to the child documents of the given parent community

Parameters:

community - the parent community

Returns:

an iterable of document import beans

getAnnouncementCount

int getAnnouncementCount(com.jivesoftware.community.importer.beans.CommunityImportBean community)

Returns a count of announcements to be imported in the given community

Parameters:

community - the parent community

Returns:

a count of announcements to be imported

getAnnouncements

java.lang.Iterable<com.jivesoftware.community.importer.beans.AnnouncementImportBean> getAnnouncements(com.jivesoftware.community.importer.beans.CommunityImportBean community)

Returns an iterable of announcement import beans corresponding to annnouncements in the given parent community

Parameters:

community - the parent community

Returns:

an iterable of announcement import beans

getPollCount

int getPollCount(com.jivesoftware.community.importer.beans.ID id)

Returns a count of polls to be imported for the given ID

Parameters:

id - the parent ID object

Returns:

a count of polls to be imported

getPolls

java.lang.Iterable<com.jivesoftware.community.importer.beans.PollImportBean> getPolls(com.jivesoftware.community.importer.beans.ID id)

Returns an iterable of poll import beans corresponding to the polls in the given ID

Parameters:

id - the parent ID object

Returns:

an iterable of poll import beans

hasPrivateMessages

boolean hasPrivateMessages()

Returns a system level check to see if there any private messages at all.

Returns:

true if there are any private messages in the system, false otherwise

getPrivateMessageFolders

java.lang.Iterable<com.jivesoftware.community.importer.beans.PrivateMessageFolderImportBean> getPrivateMessageFolders(com.jivesoftware.community.importer.beans.ID id)

Returns an iterable of private message folder import beans corresponding to the private message folders for the given user

Parameters:

id - the ID of the user to retrieve the private message folders for

Returns:

an iterable of private message folder import beans

getWatchCount

int getWatchCount()

Returns a count of watches to be imported

Returns:

a count of watches to be imported

getWatches

java.lang.Iterable<com.jivesoftware.community.importer.beans.WatchImportBean> getWatches()

Returns an iterable of watch import beans corresponding to the watches to be imported

Returns:

an iterable of watch import beans

getRatingCount

int getRatingCount(com.jivesoftware.community.importer.beans.ID id)

Returns a count of ratings to be imported for the given ID

Parameters:

id - the parent ID object

Returns:

a count of ratings to be imported

getRatings

java.lang.Iterable<com.jivesoftware.community.importer.beans.RatingImportBean> getRatings(com.jivesoftware.community.importer.beans.ID id)

Returns an iterable of rating import beans corresponding to the ratings to be imported in the given ID

Parameters:

id - the parent ID object

Returns:

an iterable of rating import beans

getRatingTypeCount

int getRatingTypeCount()

Returns a count of rating types to be imported

Returns:

a count of rating types to be imported

getRatingTypes

java.lang.Iterable<com.jivesoftware.community.importer.beans.RatingTypeImportBean> getRatingTypes()

Returns an iterable of rating type import beans corresponding to the rating types to be imported

Returns:

an iterable of rating type import beans

getPermissionCount

int getPermissionCount(com.jivesoftware.community.importer.beans.ID id)

Returns a count of permissions to be imported for the given ID

Parameters:

id - the parent ID object

Returns:

a count of permissions to be imported

getPermissions

com.jivesoftware.community.importer.beans.PermissionsImportBean getPermissions(com.jivesoftware.community.importer.beans.ID id)

Returns the permission import bean corresponding to the given ID

Parameters:

id - the parent ID object

Returns:

a permission import bean

getAbuseCount

int getAbuseCount()

Returns a count of abuse reports to be imported

Returns:

a count of abuse reports to be imported

getAbuse

java.lang.Iterable<com.jivesoftware.community.importer.beans.AbuseImportBean> getAbuse()

Returns an iterable of abuse import beans corresponding to the aubse reports to be imported

Returns:

an iterable of abuse import beans

getBanCount

int getBanCount()

Returns a count of bans to be imported

Returns:

a count of bans to be imported

getBans

java.lang.Iterable<com.jivesoftware.community.importer.beans.BanImportBean> getBans()

Returns an iterable of ban import beans corresponding to the bans to be imported

Returns:

an iterable of ban import beans

getStatusLevelCount

int getStatusLevelCount()

Returns a count of status levels to be imported

Returns:

a count of status levels to be imported

getStatusLevels

java.lang.Iterable<com.jivesoftware.community.importer.beans.StatusLevelImportBean> getStatusLevels()

Returns an iterable of status level import beans corresponding to the status levels to be imported

Returns:

an iterable of status level import beans

getGatewayCount

int getGatewayCount()

Returns a count of gateways to be imported

Returns:

a count of gateways to be imported

getGateways

java.lang.Iterable<com.jivesoftware.community.importer.beans.GatewayImportBean> getGateways()

Returns an iterable of gateway import beans corresponding to the gateways to be imported

Returns:

an iterable of gateway import beans

getAttachmentCount

int getAttachmentCount(com.jivesoftware.community.importer.beans.ID id)

Returns a count of attachments to be imported

Parameters:

id - the parent ID object

Returns:

a count of attachments to be imported

getAttachments

java.lang.Iterable<com.jivesoftware.community.importer.beans.AttachmentImportBean> getAttachments(com.jivesoftware.community.importer.beans.ID id)

Returns an iterable of attachment import beans corresponding to the attachments for the given ID

Parameters:

id - the parent ID object

Returns:

an iterable of attachment import beans

getImageCount

int getImageCount(com.jivesoftware.community.importer.beans.ID id)

Returns a count of images to be imported

Parameters:

id - the parent ID object

Returns:

a count of images to be imported

getImages

java.lang.Iterable<com.jivesoftware.community.importer.beans.ImageImportBean> getImages(com.jivesoftware.community.importer.beans.ID id)

Returns an iterable of image import beans corresponding to the images for the given ID

Parameters:

id - the parent ID object

Returns:

an iterable of image import beans

getAvatarCount

int getAvatarCount()

Returns a count of avatars to be imported

Returns:

a count of avatars to be imported

getAvatars

java.lang.Iterable<com.jivesoftware.community.importer.beans.AvatarImportBean> getAvatars()

Returns an iterable of avatar import beans corresponding to the avatars to be imported

Returns:

an iterable of avatar import beans

getSystemProperties

java.util.Map<java.lang.String,java.lang.String> getSystemProperties()

Returns a map of system properties to be imported

Returns:

a map of system properties to be imported

getStatusLevelPointsForCommunity

java.lang.Iterable<com.jivesoftware.community.importer.beans.StatusLevelPointImportBean> getStatusLevelPointsForCommunity(com.jivesoftware.community.importer.beans.ID communityID)

Returns status levels points for a particular community.

Parameters:

communityID - The id of the community.

Returns:

an iterable of status level point import beans

getStatusLevelHelpfulPoints

int getStatusLevelHelpfulPoints()

Helpful answer points. This is a multiplier used to determine how many helpful answer points a user has. This method checks to see if there was custom value placed in the system property answerCount.helpfulPoints, if there is not 5 is returned.

Returns:

The helpful answer point multiplier

getStatusLevelCorrectPoints

int getStatusLevelCorrectPoints()

Correct answer points. This is a multiplier used to determine how many correct answer points a user has. This method checks to see if there was custom value placed in the system property answerCount.helpfulPoints, if there is not 10 is returned.

Returns:

The correct answer point multiplier

getTags

java.lang.Iterable<java.lang.String> getTags(com.jivesoftware.community.importer.beans.ID id)

Returns an iterable of tags for the given ID

Parameters:

id - the parent ID object

Returns:

an iterable of tags for the given ID

getViewCountCount

int getViewCountCount()

Returns the count of all the view counts

Returns:

a count of all the view counts in the system

getViewCounts

java.lang.Iterable<com.jivesoftware.community.importer.beans.ViewCountImportBean> getViewCounts()

Returns all the view counts

Returns:

an iterable of all the view counts in the system

getQuestionAnswerCount

int getQuestionAnswerCount()

Returns a count of all the question answer data in the system

Returns:

a count of all the question answer data in the system

getQuestionAnswers

java.lang.Iterable<com.jivesoftware.community.importer.beans.QuestionAnswerImportBean> getQuestionAnswers()

Returns all the question answer data

Returns:

an iterable of question answer import beans

getCompletionTasks

java.lang.Iterable<com.jivesoftware.community.importer.ImportTask> getCompletionTasks()

Returns an iterable of ImportTasks that should be run after the rest of the import is complete.

Returns:

an iterable of ImportTasks