com.virtuosotechnologies.asaph.model.opsemantics
Class GetFirstLineSemantics.DefaultImplementation

java.lang.Object
  com.virtuosotechnologies.asaph.model.opsemantics.GetFirstLineSemantics.DefaultImplementation

All Implemented Interfaces:

GetFirstLineSemantics, SongOperation

Enclosing class:

GetFirstLineSemantics

public static class GetFirstLineSemantics.DefaultImplementation

extends Object

implements GetFirstLineSemantics

The default implementation of GetFirstLineSemantics

Nested Class Summary

Nested classes inherited from class com.virtuosotechnologies.asaph.model.opsemantics.GetFirstLineSemantics

GetFirstLineSemantics.DefaultImplementation

Constructor Summary

GetFirstLineSemantics.DefaultImplementation(boolean useVariation, SongUtils songUtils)
Constructor

Method Summary

boolean	equals(Object obj) The equals method should return true if the given object is a SongOperation with the same semantics as this one.
boolean	isUsingVariation() True if using just the default variation, or false for the entire song text
void	perform(SongIDResultSet resultSet) Performs the operation on the given result set.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetFirstLineSemantics.DefaultImplementation

public GetFirstLineSemantics.DefaultImplementation(boolean useVariation,
                                                   SongUtils songUtils)

Constructor

Parameters:

useVariation - true to use the default variation, or false for the entire song text

songUtils - SongUtils api

Method Detail

isUsingVariation

public boolean isUsingVariation()

True if using just the default variation, or false for the entire song text

Specified by:

isUsingVariation in interface GetFirstLineSemantics

Returns:

true if using the default variation

perform

public void perform(SongIDResultSet resultSet)
             throws SongDatabaseFailedException

Performs the operation on the given result set.

Specified by:

perform in interface SongOperation

Parameters:

resultSet - the SongIDResultSet

Throws:

SongDatabaseFailedException - Catch-all exception for database-related problems. This will often have a cause exception, which may be exceptions like IOException or SQLException.

equals

public boolean equals(Object obj)

The equals method should return true if the given object is a SongOperation with the same semantics as this one. (i.e. it would perform the same operation.) This may be used to optimize performance. It is always safe to return false from this method, if the semantics of the given object cannot be determined. (This is similar to the equals method in java.util.Comparator.) As a corollary, it is safe just to fall back on the default implementation inherited from java.lang.Object.

Specified by:

equals in interface SongOperation

Parameters:

obj - object to test

Returns:

true if the object is equal