|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.tuberlin.cs.flp.jspwiki.CategoryManager
Handles Categories in the Wiki. A category is a page which contains other pages in the sense that
CategoriesMemberPhrases
(or as configured via jspwiki.categories.memberPhrases.page
)de.tuberlin.cs.flp.jspwiki.plugin.Category
(and usually nothing more, i.e. the category-page does not contain links to its members in wiki markup, but links are displayed by the plugin)Categories
page (or as configured via jspwiki.categories.page
)
Category
,
de.tuberlin.cs.flp.jspwiki.tags.CategoryIterator
Field Summary | |
static java.lang.String |
CATEGORY_EDITINFO_SUFFIX
|
static java.lang.String |
CATEGORY_INFO_SUFFIX
|
static java.lang.String |
CATEGORY_INITIAL_SUFFIX
Image file suffices to identify an image by its filename. |
static java.lang.String |
DEFAULT_CATEGORY_MEMBER_PHRASES_PAGE
|
static java.lang.String |
DEFAULT_CATEGORY_PAGE
Default name of the central Categories page. |
protected WikiEngine |
engine
|
protected java.util.Map |
existingCategoryMembersCacheByCategory
Represents ... |
protected static java.util.Map |
instancesByEngine
Represents ... |
protected java.util.Map |
membersToBeCreatedByCategory
|
protected java.util.Map |
membersToBeCreatedTimestamp
|
static long |
NEW_MEMBER_TIMEOUT_SECONDS
|
static java.lang.String |
PROPERTY_CATEGORY_MEMBER_PHRASES_PAGE
|
static java.lang.String |
PROPERTY_CATEGORY_PAGE
Property holding the name of the central Categories page on which all CategoryXxx pages are registered to become known as categories. |
Constructor Summary | |
protected |
CategoryManager(WikiEngine engine)
|
Method Summary | |
void |
actionPerformed(WikiEvent e)
Implementation of WikiEventListener. |
void |
addCategoryMember(java.lang.String category,
java.lang.String newPage)
Adds a new member to the category. |
java.util.Collection |
getAllCategories()
Returns all categories used in the wiki. |
java.util.Collection |
getCategories(java.lang.String page)
Returns all categories in which the page is a member. |
java.util.Collection |
getCategoryMemberPhrases()
Returns all member-phrases that mark a page as being a member of a category. |
java.lang.String |
getCategoryMemberPhrasesPageName()
Returns the name of the central CategoriePhrasesPage, which contains any number of possible textual phrases (seperated by blank lines in the Wiki markup) that mark a page as being a member of a category. |
java.util.Collection |
getCategoryMembers(java.lang.String category)
Gets all embers of a category, including those that have been registered as yet-to-be-created members. |
java.lang.String |
getCategoryPageName()
Returns the name of the central Categories page on which all categories are registered as links to the individual CategoryXxx pages. |
java.lang.String |
getDefaultCategoryMemberPhrase()
Returns the default member-phrase that marks a page as being a member of a category, also if no CategoriesMemberPhrases page (or accordingly configured via jspwiki.category.memberPhrases.page). |
WikiEngine |
getEngine()
|
java.util.Collection |
getExistingCategoryMembers(java.lang.String category)
Gets the members of a category which actually exist as saved pages. |
protected java.util.Collection |
getExistingCategoryMembersUncached(java.lang.String category)
Gets the members of a category which actually exist as saved pages. |
static CategoryManager |
getInstance(WikiEngine engine)
Static method to get an instance of CategoryManager. |
java.util.Collection |
getNewCategoryMembers(java.lang.String category)
Gets those category members that have already been added to the category but do not yet exist as saved pages. |
boolean |
isCategory(java.lang.String page)
Tests if a page is a category page. |
protected java.util.Collection |
membersToBeCreated(java.lang.String category)
Gets those category members that have been added to the category but are not yet tested whether they might in the meantime have been actually created as saved pages. |
void |
setEngine(WikiEngine wikiEngine)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String CATEGORY_INITIAL_SUFFIX
public static final java.lang.String CATEGORY_INFO_SUFFIX
public static final java.lang.String CATEGORY_EDITINFO_SUFFIX
public static final java.lang.String PROPERTY_CATEGORY_PAGE
public static final java.lang.String DEFAULT_CATEGORY_PAGE
public static final java.lang.String PROPERTY_CATEGORY_MEMBER_PHRASES_PAGE
public static final java.lang.String DEFAULT_CATEGORY_MEMBER_PHRASES_PAGE
public static final long NEW_MEMBER_TIMEOUT_SECONDS
protected static java.util.Map instancesByEngine
Represents ...
protected java.util.Map membersToBeCreatedByCategory
protected java.util.Map membersToBeCreatedTimestamp
protected java.util.Map existingCategoryMembersCacheByCategory
Represents ...
protected WikiEngine engine
Constructor Detail |
protected CategoryManager(WikiEngine engine)
engine
- Method Detail |
public static CategoryManager getInstance(WikiEngine engine)
engine
-
public java.lang.String getCategoryPageName()
public java.lang.String getCategoryMemberPhrasesPageName()
public java.util.Collection getCategoryMemberPhrases()
public java.lang.String getDefaultCategoryMemberPhrase()
protected java.util.Collection getExistingCategoryMembersUncached(java.lang.String category)
category
-
public java.util.Collection getAllCategories()
public java.util.Collection getExistingCategoryMembers(java.lang.String category)
category
-
public java.util.Collection getCategoryMembers(java.lang.String category)
category
-
public boolean isCategory(java.lang.String page)
page
-
public java.util.Collection getCategories(java.lang.String page)
page
-
public void addCategoryMember(java.lang.String category, java.lang.String newPage)
category
- newPage
- public java.util.Collection getNewCategoryMembers(java.lang.String category)
category
-
protected java.util.Collection membersToBeCreated(java.lang.String category)
category
-
public void actionPerformed(WikiEvent e)
e
- public WikiEngine getEngine()
public void setEngine(WikiEngine wikiEngine)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |