bbc.rd.tvanytime.util
Class GenreToolbox

java.lang.Object
  bbc.rd.tvanytime.util.GenreToolbox

Direct Known Subclasses:

TVAnytimeGenreToolbox, TVAnytimeHowRelatedToolbox

public class GenreToolbox
extends java.lang.Object

GenreToolBox: Contains tools for use with Genres. Should not be instantiated. Should be inherited from and have its static methods implemented.

Version:

1.0

Author:

Chris Akanbi, BBC Research & Development, April 2002

Method Summary

static java.util.Vector	findGenre(java.lang.String genreName) findGenre - returns the named hierarchy of any genres containing the specifed genre name
static java.lang.String	getNameHierarchy(java.lang.String numberHierarchy) getNameHierarchy - converts a numbered hierarchy to its corresponding name hierarchy
static java.lang.String	getNumberHierarchy(java.lang.String nameHierarchy) getNumberHierarchy - converts a named hierarchy to its corresponding number hierarchy
static int	getNumLevels(java.lang.String hierarchy) getNumLevels - returns the number of levels used in the Genre hierarchy passed
static java.lang.String	getParent(java.lang.String hierarchy) getParent - returns the Genre hierarchy of the Genre one level up the Genre hierarchy from the the Genre hierarchy passed
static java.util.Vector	getSubGenres(java.lang.String genreParent) getSubGenres - from a genre heading(in numbered hierarchy form) get any sub-genres
static java.util.Vector	getTopLevelSubGenres(java.lang.String genreParent) getTopLevelSubGenres - from a genre heading(in numbered hierarchy form) get the immediate child sub-genres only.
static boolean	isValid(java.lang.String genreHierarchy) isValid - verifies whether a genre hierarchy is included in the current genre scheme

Methods inherited from class java.lang.Object

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

Method Detail

getNameHierarchy

public static java.lang.String getNameHierarchy(java.lang.String numberHierarchy)

getNameHierarchy - converts a numbered hierarchy to its corresponding name hierarchy

Parameters:

numberHierarchy - the numbered hierarchy String to be converted

Returns:

null

getNumberHierarchy

public static java.lang.String getNumberHierarchy(java.lang.String nameHierarchy)

getNumberHierarchy - converts a named hierarchy to its corresponding number hierarchy

Parameters:

nameHierarchy - the named hierarchy String to be converted

Returns:

null

getSubGenres

public static java.util.Vector getSubGenres(java.lang.String genreParent)

getSubGenres - from a genre heading(in numbered hierarchy form) get any sub-genres

Parameters:

genreParent - the genre heading(numbered hierarchy String) from which sub genres are to be found

Returns:

null

getTopLevelSubGenres

public static java.util.Vector getTopLevelSubGenres(java.lang.String genreParent)

getTopLevelSubGenres - from a genre heading(in numbered hierarchy form) get the immediate child sub-genres only.

Parameters:

genreParent - the genre heading (number hierarchy) from which sub genres are to be found. If null then returns all top-level genres only.

Returns:

null

findGenre

public static java.util.Vector findGenre(java.lang.String genreName)

findGenre - returns the named hierarchy of any genres containing the specifed genre name

Parameters:

genreName - the genre name String to be searched for

Returns:

null

isValid

public static boolean isValid(java.lang.String genreHierarchy)

isValid - verifies whether a genre hierarchy is included in the current genre scheme

Parameters:

genreHierarchy - the hierarchy String (named or numbered)to be verified

Returns:

false

getParent

public static java.lang.String getParent(java.lang.String hierarchy)

getParent - returns the Genre hierarchy of the Genre one level up the Genre hierarchy from the the Genre hierarchy passed

Parameters:

hierarchy - the hierarchy String of the Genre whose parent is desired (can be numbered or named)

Returns:

null

getNumLevels

public static int getNumLevels(java.lang.String hierarchy)

getNumLevels - returns the number of levels used in the Genre hierarchy passed

Parameters:

hierarchy - the numbered or named hierarchy String of the Genre object whose number of levels is desired

Returns:

0