cat.lump.aq.textextraction.wikipedia.categories

Class GroupOfCategories

java.lang.Object

cat.lump.aq.textextraction.wikipedia.categories.GroupOfCategories

public class GroupOfCategories
extends java.lang.Object

A GroupOfCategories instance contains the scored categories from Wikipedia which are related to other called root category. This class doesn't implement any rule to determine if a category must be included in the group or not.

A scored category is a Wikipedia category which has been checked if it belongs to a certain domain.

Author:

cmops

See Also:

de.tudarmstadt.ukp.wikipedia.api.Category, GroupOfCategories.ScoredCategory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupOfCategories.ScoredCategory The ScoredCategory class enriches the de.tudarmstadt.ukp.wikipedia.api.Category objects providing the following information: Parent: The first category which allows access to this one.

Constructor Summary

Constructors

Constructor and Description
GroupOfCategories(Category root) Creates an empty group of categories related to the given root category.
GroupOfCategories(java.io.File input, WikipediaJwpl wiki)

Method Summary

Methods

Modifier and Type	Method and Description
void	addScoredCategory(GroupOfCategories.ScoredCategory category) Adds a new ScoredCategory to the group.
static GroupOfCategories.ScoredCategory	createScoredCategory(Category cat, Category parent, int distance)
static GroupOfCategories.ScoredCategory	createScoredCategory(Category cat, Category parent, int distance, boolean isDomain)
java.util.Collection<GroupOfCategories.ScoredCategory>	getCategories()
Category	getRoot()
double	getScore()
GroupOfCategories.ScoredCategory	removeScoredCategory(GroupOfCategories.ScoredCategory category)
void	toFile(java.io.File output)

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupOfCategories

public GroupOfCategories(Category root)

Creates an empty group of categories related to the given root category.

Parameters:

root - Root category of the group.

GroupOfCategories

public GroupOfCategories(java.io.File input,
                 WikipediaJwpl wiki)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

createScoredCategory

public static GroupOfCategories.ScoredCategory createScoredCategory(Category cat,
                                                    Category parent,
                                                    int distance)

createScoredCategory

public static GroupOfCategories.ScoredCategory createScoredCategory(Category cat,
                                                    Category parent,
                                                    int distance,
                                                    boolean isDomain)

addScoredCategory

public void addScoredCategory(GroupOfCategories.ScoredCategory category)

Adds a new ScoredCategory to the group.

Parameters:

category - The new scored category

removeScoredCategory

public GroupOfCategories.ScoredCategory removeScoredCategory(GroupOfCategories.ScoredCategory category)

toFile

public void toFile(java.io.File output)
            throws java.io.IOException

Throws:

java.io.IOException

getRoot

public Category getRoot()

getCategories

public java.util.Collection<GroupOfCategories.ScoredCategory> getCategories()

getScore

public double getScore()