org.stanwood.media.actions.rename
Class PatternMatcher

java.lang.Object
  extended by org.stanwood.media.actions.rename.PatternMatcher

public class PatternMatcher
extends java.lang.Object

This class is used to translate media directory patterns into filenames with the media


Constructor Summary
PatternMatcher()
           
 
Method Summary
 java.lang.String getNewFilmName(MediaDirConfig dirConfig, java.lang.String pattern, IFilm film, java.lang.String ext, java.lang.Integer part, IMediaFileInfo info)
          Get a file name for a film pattern
 java.lang.String getNewTVShowName(MediaDirConfig dirConfig, java.lang.String pattern, IEpisode episode, java.lang.String ext, IMediaFileInfo info)
          Get a file name for a TV show pattern
static java.lang.String normalizeText(java.lang.String text)
          Used to strip unwanted characters from a filename
static boolean validPattern(java.lang.String pattern)
          Used to check a pattern is valid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PatternMatcher

public PatternMatcher()
Method Detail

normalizeText

public static java.lang.String normalizeText(java.lang.String text)
Used to strip unwanted characters from a filename

Parameters:
text - The input text
Returns:
The converted text

getNewFilmName

public java.lang.String getNewFilmName(MediaDirConfig dirConfig,
                                       java.lang.String pattern,
                                       IFilm film,
                                       java.lang.String ext,
                                       java.lang.Integer part,
                                       IMediaFileInfo info)
                                throws PatternException
Get a file name for a film pattern

Parameters:
dirConfig - The media directory configuration where the film is to be located
pattern - The pattern
film - The film information
ext - The film extension
part - The part number of the film
info - The media file information
Returns:
The filename
Throws:
PatternException - thrown if their is a problem

getNewTVShowName

public java.lang.String getNewTVShowName(MediaDirConfig dirConfig,
                                         java.lang.String pattern,
                                         IEpisode episode,
                                         java.lang.String ext,
                                         IMediaFileInfo info)
                                  throws PatternException
Get a file name for a TV show pattern

Parameters:
dirConfig - The media directory configuration where the episode is to be located
pattern - The pattern
episode - The Episode information
ext - The film extension
info - The media file information
Returns:
The filename
Throws:
PatternException - thrown if their is a problem

validPattern

public static boolean validPattern(java.lang.String pattern)
Used to check a pattern is valid

Parameters:
pattern - The pattern
Returns:
true if valid, otherwise false