com.jalios.jcms.mention

Class MentionManager

java.lang.Object

com.jalios.jcms.mention.MentionManager

All Implemented Interfaces:

JPropertiesListener

public final class MentionManager
extends java.lang.Object
implements JPropertiesListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MentionManager.EmailSelector DataSelector used to find any member whose mail starts with given emailPrefix

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<TypeEntry,java.util.List<TypeFieldEntry>>	mentionableTFEByTypeMap

Fields inherited from interface com.jalios.util.JPropertiesListener

REVISION

Method Summary

Methods

Modifier and Type	Method and Description
DBMember	getDBMemberFromEmailPrefix(java.lang.String emailPrefix) Returns a DBMember, which is an account, and whose mail starts with the given email prefix
java.lang.String	getHtmlPrefix()
java.lang.String	getIconPrefixProp()
static MentionManager	getInstance()
Member	getMemberFromEmailPrefix(java.lang.String emailPrefix) Returns a member by searching in Store Members and DBMembers any matching member with email starting with the given email prefix
Member	getMemberFromEmailPrefixCache(java.lang.String emailPrefix)
java.util.Set<Member>	getMentionedMemberSet(Publication pub) Returns mentioned member set in the given publication by searching through all its values (multivaluated && multilingual) An empty set is returned if the Publication is not in a visible state
java.util.Set<Member>	getMentionedMemberSet(java.lang.String text)
java.lang.String	getMentionEmailPrefixFromString(java.lang.String text)
java.lang.String	getMentionHtmlPrefix() Returns the html prefix build with the following properties : mention.htmlprefix : an html prefix mention.html.icon.prefix-prop: an icon property mention.html.whitespace.prefix: a boolean to define if a whitespace is needed Note : if an icon is defined, the htmlprefix is not used
java.util.regex.Pattern	getMentionMailPrefixPattern()
java.lang.String	getMentionMailPrefixRegex()
java.util.regex.Pattern	getMentionPattern()
java.util.List<TypeFieldEntry>	getTypeEntryMentionableFields(TypeEntry typeEntry)
boolean	hasWhiteSpacePrefix()
boolean	isMentionEnabled()
void	notifyMention(Publication pub, Member opAuthor, java.util.Set<Member> memberSet) Notifies mentioned member set on the given Publication
void	notifyMention(Publication pub, java.util.Set<Member> memberSet) Deprecated. since jcms-9.0.2 : use notifyMention(Publication, Member, Set)
void	propertiesChange(JProperties properties) Invoked after properties have been modified in JCMS and save on disk.

Methods inherited from class java.lang.Object

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

Field Detail

mentionableTFEByTypeMap

public java.util.Map<TypeEntry,java.util.List<TypeFieldEntry>> mentionableTFEByTypeMap

Method Detail

getInstance

public static MentionManager getInstance()

propertiesChange

public void propertiesChange(JProperties properties)

Description copied from interface: JPropertiesListener

Invoked after properties have been modified in JCMS and save on disk.

You cannot alter the value received in parameters.

Specified by:

propertiesChange in interface JPropertiesListener

Parameters:

properties - the properties which have been modified (may not contain all JCMS properties)

getMentionMailPrefixRegex

public java.lang.String getMentionMailPrefixRegex()

Returns:

the mention regexp property value

Since:

jcms-9.0.1

getMentionPattern

public java.util.regex.Pattern getMentionPattern()

Returns:

the mention regexp Pattern

Since:

jcms-9.0.1

getMentionMailPrefixPattern

public java.util.regex.Pattern getMentionMailPrefixPattern()

Returns:

the mention mail prefix regexp Pattern

Since:

jcms-9.0.1

isMentionEnabled

public boolean isMentionEnabled()

Returns:

true if mentions are enabled on this webapp

Since:

jcms-9.0.1

getHtmlPrefix

public java.lang.String getHtmlPrefix()

Returns:

the html prefix that will be added to the html of a mentioned member

Since:

jcms-9.0.1

getIconPrefixProp

public java.lang.String getIconPrefixProp()

Returns:

the icon prefix that will be added to the html of a mentioned member

Since:

jcms-9.0.1

hasWhiteSpacePrefix

public boolean hasWhiteSpacePrefix()

Returns:

true if there must be a white space before the rendered mention in wiki

Since:

jcms-9.0.1

getMentionHtmlPrefix

public java.lang.String getMentionHtmlPrefix()

Returns the html prefix build with the following properties :

• mention.htmlprefix : an html prefix
• mention.html.icon.prefix-prop: an icon property
• mention.html.whitespace.prefix: a boolean to define if a whitespace is needed

Note : if an icon is defined, the htmlprefix is not used

Returns:

the prefix that is displayed before the member name when rendered in a wiki

Since:

jcms-9.0.1

getMentionedMemberSet

public java.util.Set<Member> getMentionedMemberSet(Publication pub)

Returns mentioned member set in the given publication by searching through all its values (multivaluated && multilingual) An empty set is returned if the Publication is not in a visible state

Parameters:

pub - the Publication

Returns:

the Set of Member mentioned in given Publication

Since:

jcms-9.0.1

getMentionedMemberSet

public java.util.Set<Member> getMentionedMemberSet(java.lang.String text)

Parameters:

text - the text to parse

Returns:

the Set of Member mentioned in given text

Since:

jcms-9.0.1

getMemberFromEmailPrefix

public Member getMemberFromEmailPrefix(java.lang.String emailPrefix)

Returns a member by searching in Store Members and DBMembers any matching member with email starting with the given email prefix

Parameters:

emailPrefix - the prefix of the member email

Returns:

a member based on given email prefix

Since:

jcms-9.0.1

getMentionEmailPrefixFromString

public java.lang.String getMentionEmailPrefixFromString(java.lang.String text)

Parameters:

text - the text to extract mail from

Returns:

the string matched after the @ symbol of given text

Since:

jcms-9.0.2

getMemberFromEmailPrefixCache

public Member getMemberFromEmailPrefixCache(java.lang.String emailPrefix)

Parameters:

emailPrefix - the email prefix

Returns:

a member from the cache

Since:

jcms-9.0.1

getDBMemberFromEmailPrefix

public DBMember getDBMemberFromEmailPrefix(java.lang.String emailPrefix)

Returns a DBMember, which is an account, and whose mail starts with the given email prefix

Parameters:

emailPrefix - the email prefix

Returns:

a DBMember whose mail starts with the given email prefix

Since:

jcms-9.0.1

getTypeEntryMentionableFields

public java.util.List<TypeFieldEntry> getTypeEntryMentionableFields(TypeEntry typeEntry)

Parameters:

typeEntry - the TypeEntry

Returns:

the list of wiki TypeFieldEntry for given TypeEntry

Since:

jcms-9.0.1

notifyMention

@Deprecated
public void notifyMention(Publication pub,
                            java.util.Set<Member> memberSet)

Deprecated. since jcms-9.0.2 : use notifyMention(Publication, Member, Set)

Notifies mentioned member set on the given Publication

Parameters:

pub - the Publication

memberSet - the set of members that will receive the alert

Since:

jcms-9.0.1

notifyMention

public void notifyMention(Publication pub,
                 Member opAuthor,
                 java.util.Set<Member> memberSet)

Notifies mentioned member set on the given Publication

Parameters:

pub - the Publication

opAuthor - the op author

memberSet - the set of members that will receive the alert

Since:

jcms-9.0.2