org.farng.mp3.filename
Class AbstractFilenameComposite

java.lang.Object
  org.farng.mp3.filename.AbstractFilenameComposite

Direct Known Subclasses:

FilenameDelimiter, FilenameToken

public abstract class AbstractFilenameComposite

extends java.lang.Object

The file name is parsed into a composite with this class as the base composite class.

Version:

$Revision: 1.3 $

Author:

Eric Farng

Constructor Summary

protected	AbstractFilenameComposite() Creates a new AbstractFilenameComposite object.
protected	AbstractFilenameComposite(AbstractFilenameComposite copyObject) Creates a new AbstractFilenameComposite object.

Method Summary

abstract java.lang.String	composeFilename() Reconstruct the filename that is represented by this composite.
abstract ID3v2_4	createId3Tag()
java.lang.String	getOriginalToken() Get the original string that this composite represents.
abstract java.util.Iterator	iterator() Returns an iterator through each FilenameToken in this composite in the correct order for the file name.
abstract void	matchAgainstKeyword(java.lang.Class id3v2FrameBodyClass) Match all elements of this composite against the keywords for this class type found in TagOptionSingleton.
abstract void	matchAgainstTag(AbstractMP3Tag matchTag) Match all elements of this composite against the given tag.
abstract void	setFrame(AbstractID3v2Frame frame)
void	setOriginalToken(java.lang.String originalToken) Sets the original string that this composite represents.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFilenameComposite

protected AbstractFilenameComposite()

Creates a new AbstractFilenameComposite object.

AbstractFilenameComposite

protected AbstractFilenameComposite(AbstractFilenameComposite copyObject)

Creates a new AbstractFilenameComposite object.

Method Detail

setFrame

public abstract void setFrame(AbstractID3v2Frame frame)

composeFilename

public abstract java.lang.String composeFilename()

Reconstruct the filename that is represented by this composite.

Returns:

the filename that is represented by this composite.

iterator

public abstract java.util.Iterator iterator()

Returns an iterator through each FilenameToken in this composite in the correct order for the file name.

Returns:

an iterator through each FilenameToken in this composite

matchAgainstKeyword

public abstract void matchAgainstKeyword(java.lang.Class id3v2FrameBodyClass)

Match all elements of this composite against the keywords for this class type found in TagOptionSingleton. If the FilenameToken matches the keyword, the token's class is set.

Parameters:

id3v2FrameBodyClass - Class of keywords to match against.

matchAgainstTag

public abstract void matchAgainstTag(AbstractMP3Tag matchTag)

Match all elements of this composite against the given tag. If any element of matchTag matches any element of this tag's composite, then this tag's composite leaf node's class is set.

Parameters:

matchTag - Tag to match against

setOriginalToken

public void setOriginalToken(java.lang.String originalToken)

Sets the original string that this composite represents.

Parameters:

originalToken - the original string that this composite represents.

getOriginalToken

public java.lang.String getOriginalToken()

Get the original string that this composite represents.

Returns:

the original string that this composite represents.

createId3Tag

public abstract ID3v2_4 createId3Tag()