tvbrowser.core.search.AbstractSearcher.java Source code

Java tutorial

Introduction

Here is the source code for tvbrowser.core.search.AbstractSearcher.java

Source

/*
 * TV-Browser
 * Copyright (C) 04-2003 Martin Oberhauser (martin@tvbrowser.org)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * CVS information:
 *  $RCSfile$
 *   $Source$
 *     $Date: 2010-04-13 09:01:05 +0200 (Tue, 13 Apr 2010) $
 *   $Author: bananeweizen $
 * $Revision: 6592 $
 */
package tvbrowser.core.search;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;

import javax.swing.DefaultListModel;
import javax.swing.SwingUtilities;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.text.StrBuilder;

import tvbrowser.core.Settings;
import tvbrowser.core.TvDataBase;
import util.program.ProgramUtilities;
import devplugin.Channel;
import devplugin.ChannelDayProgram;
import devplugin.Date;
import devplugin.Program;
import devplugin.ProgramFieldType;
import devplugin.ProgramSearcher;
import devplugin.ProgressMonitor;

/**
 * An abstract searcher implementation that reduces the checks on String checks.
 *
 * @author Til Schneider, www.murfman.de
 */
public abstract class AbstractSearcher implements ProgramSearcher {
    /** Translator */

    /** The comparator that compares two programs by their start time and date */
    private static Comparator<Program> mStartTimeComparator;

    /** Indicates if the special characters should be replaced.*/
    protected boolean mReplaceSpCh = false;

    /**
     * Gets or creates the start time comparator.
     *
     * @return The start time comparator
     */
    private static Comparator<Program> getStartTimeComparator() {
        if (mStartTimeComparator == null) {
            // Create an comparator that compares two programs by their start time and date
            mStartTimeComparator = new Comparator<Program>() {
                public int compare(Program prog1, Program prog2) {
                    int dateComp = prog1.getDate().compareTo(prog2.getDate());
                    if (dateComp == 0) {
                        // Both program are at the same date -> Check the start time
                        return prog1.getStartTime() - prog2.getStartTime();
                    } else {
                        return dateComp;
                    }
                }
            };
        }

        return mStartTimeComparator;
    }

    /**
     * Checks whether a field of a program matches to the criteria of this
     * searcher.
     *
     * @param prog The program to check.
     * @param fieldArr The fields to search in.
     * @return Whether at least one field of the program matches.
     */
    public boolean matches(Program prog, ProgramFieldType[] fieldArr) {
        if (fieldArr == null) {
            // Search in nothing? This won't match...
            return false;
        }

        /* Concatenate all fields into one string and do the match */
        String allFields = getProgramFieldsText(prog, fieldArr);

        if (StringUtils.isEmpty(allFields)) {
            return false;
        } else {
            return matches(allFields);
        }
    }

    /**
     * get the searchable text for all given program fields contained in this
     * program
     *
     * @param prog
     * @param fieldArr
     * @return concatenated string for use in regex search
     */
    private String getProgramFieldsText(Program prog, ProgramFieldType[] fieldArr) {
        if (fieldArr.length == 1) {
            ProgramFieldType fieldType = fieldArr[0];
            if (fieldType.getFormat() == ProgramFieldType.TEXT_FORMAT) {
                return prog.getTextField(fieldType);
            } else if (fieldType.getFormat() == ProgramFieldType.INT_FORMAT) {
                return prog.getIntFieldAsString(fieldType);
            } else if (fieldType.getFormat() == ProgramFieldType.TIME_FORMAT) {
                if (fieldType == ProgramFieldType.START_TIME_TYPE) {
                    return prog.getTimeString();
                } else if (fieldType == ProgramFieldType.END_TIME_TYPE) {
                    return prog.getEndTimeString();
                } else {
                    return prog.getTimeFieldAsString(fieldType);
                }
            }
        }

        StrBuilder buffer = new StrBuilder();
        for (ProgramFieldType fieldType : fieldArr) {
            // Get the field value as String
            String value = null;
            if (fieldType != null) {
                if (fieldType.getFormat() == ProgramFieldType.TEXT_FORMAT) {
                    value = prog.getTextField(fieldType);
                } else if (fieldType.getFormat() == ProgramFieldType.INT_FORMAT) {
                    value = prog.getIntFieldAsString(fieldType);
                } else if (fieldType.getFormat() == ProgramFieldType.TIME_FORMAT) {
                    if (fieldType == ProgramFieldType.START_TIME_TYPE) {
                        value = prog.getTimeString();
                    } else if (fieldType == ProgramFieldType.END_TIME_TYPE) {
                        value = prog.getEndTimeString();
                    } else {
                        value = prog.getTimeFieldAsString(fieldType);
                    }
                }
            }

            if (value != null) {
                buffer.append(value).append(' ');
            }
        }

        /* Remove special characters */

        if (mReplaceSpCh) {
            buffer.replaceAll("\\p{Punct}", ";");
        }

        // remove line breaks
        buffer.replaceAll('\n', ' ');
        return buffer.trim().toString();
    }

    public synchronized Program[] search(ProgramFieldType[] fieldArr, Date startDate, int nrDays,
            Channel[] channels, boolean sortByStartTime, ProgressMonitor progress) {
        return search(fieldArr, startDate, nrDays, channels, sortByStartTime, progress, null);
    }

    public synchronized Program[] search(ProgramFieldType[] fieldArr, Date startDate, int nrDays,
            Channel[] channels, boolean sortByStartTime, ProgressMonitor progress,
            final DefaultListModel listModel) {

        // Should we search in all channels?
        if (channels == null) {
            channels = Settings.propSubscribedChannels.getChannelArray();
        }

        if (nrDays < 0) {
            // Search complete data, beginning yesterday to 4 weeks into the future
            startDate = Date.getCurrentDate().addDays(-1);
            nrDays = TvDataBase.getInstance().getMaxSupportedDate().getNumberOfDaysSince(startDate);
        }

        // Perform the actual search
        ArrayList<Program> hitList = new ArrayList<Program>();
        int lastDayWithData = 0;
        if (progress != null) {
            progress.setMaximum(channels.length * (nrDays + 1));
        }
        for (int day = 0; day <= nrDays; day++) {
            for (int channelIdx = 0; channelIdx < channels.length; channelIdx++) {
                if (progress != null) {
                    progress.setValue(day * channels.length + channelIdx);
                }
                Channel channel = channels[channelIdx];
                if (channel != null) {
                    ChannelDayProgram dayProg = TvDataBase.getInstance().getDayProgram(startDate, channel);
                    if (dayProg != null) {
                        // This day has data -> remember it
                        lastDayWithData = day;

                        // Search this day program
                        for (int i = 0; i < dayProg.getProgramCount(); i++) {
                            final Program prog = dayProg.getProgramAt(i);
                            if (matches(prog, fieldArr)) {
                                if (listModel != null) {
                                    SwingUtilities.invokeLater(new Runnable() {
                                        public void run() {
                                            int insertIndex = 0;

                                            for (int index = 0; index < listModel.getSize(); index++) {
                                                Program p = (Program) listModel.get(index);

                                                if (ProgramUtilities.getProgramComparator().compare(p, prog) < 0) {
                                                    insertIndex = index + 1;
                                                }
                                            }

                                            listModel.add(insertIndex, prog);
                                        }
                                    });
                                }

                                hitList.add(prog);
                            }
                        }
                    }
                }
            }

            // Give up if we did not find data for the last 10 days
            if ((day - lastDayWithData) > 10) {
                break;
            }

            // The next day
            startDate = startDate.addDays(1);
        }

        // Convert the list into an array
        Program[] hitArr = new Program[hitList.size()];
        hitList.toArray(hitArr);

        // Sort the array if wanted
        if (sortByStartTime) {
            Arrays.sort(hitArr, getStartTimeComparator());
        }

        if (progress != null) {
            progress.setValue(0);
            progress.setMessage("");
        }

        // return the result
        return hitArr;
    }

    public synchronized Program[] search(ProgramFieldType[] fieldArr, Date startDate, int nrDays,
            Channel[] channels, boolean sortByStartTime) {
        return search(fieldArr, startDate, nrDays, channels, sortByStartTime, null);
    }

    /**
     * Checks whether a value matches to the criteria of this searcher.
     *
     * @param value The value to check
     * @return Whether the value matches.
     */
    protected abstract boolean matches(String value);

}