Author: andre Date: 2010-02-02 20:05:03 +0100 (Tue, 02 Feb 2010) New Revision: 40810
Modified: mmbase/branches/MMBase-1_9/applications/media/src/main/java/org/mmbase/applications/media/filters/MainFilter.java Log: javadoc Modified: mmbase/branches/MMBase-1_9/applications/media/src/main/java/org/mmbase/applications/media/filters/MainFilter.java =================================================================== --- mmbase/branches/MMBase-1_9/applications/media/src/main/java/org/mmbase/applications/media/filters/MainFilter.java 2010-02-02 17:48:33 UTC (rev 40809) +++ mmbase/branches/MMBase-1_9/applications/media/src/main/java/org/mmbase/applications/media/filters/MainFilter.java 2010-02-02 19:05:03 UTC (rev 40810) @@ -6,7 +6,7 @@ The license (Mozilla version 1.0) can be read at the MMBase site. See http://www.MMBase.org/license - */ +*/ package org.mmbase.applications.media.filters; @@ -22,17 +22,15 @@ /** * This is the main class for the filter process. It maintains list of - * Filters (which content can be configured by the 'filters.xml' - * configuration file. It does not do any filtering itself, it is only - * the access to the actual filters, so filtering is completably - * configurable. + * Filters (which can be configured in the 'filters.xml' configuration file). + * It does not do any filtering itself, it is only to access to the actual + * filters, so filtering is completely configurable. * * Since there can be only one 'main' filter this class is a - * Singleton, and its one instance can be gotten by the getInstance - * function (and this is done by the Media builders when they need url + * Singleton, and its one instance can be gotten by the #getInstance() + * function (and this is done by Media builders when they need url * representations to the stream they describe). * - * * @author Rob Vermeulen (VPRO) * @author Michiel Meeuwissen */ @@ -57,7 +55,7 @@ private final List<Filter> filters = new ArrayList<Filter>(); /** - * Construct the MainFilter + * Construct MainFilter */ private MainFilter() { String configFile = CONFIG_FILE; @@ -79,7 +77,8 @@ /** - * read the MainFilter configuration + * Read MainFilter configuration + * @param configFile configuration file 'config/media/filters.xml' */ private synchronized void readConfiguration(String configFile) { if (log.isServiceEnabled()) { @@ -92,7 +91,7 @@ DocumentReader reader = new DocumentReader(ResourceLoader.getConfigurationRoot().getDocument(configFile, DocumentReader.validate(), getClass())); Element filterConfigs = reader.getElementByPath(MAIN_TAG + "." + FILTERCONFIGS_TAG); - // When chaining 'comparators' then they are combined to one comparator + // When chaining 'comparators' they are combined to one comparator. // Then only one 'sort' has to be done, which is more efficient. for(Element chainElement:reader.getChildElements(MAIN_TAG + "." + CHAIN_TAG, FILTER_TAG)) { _______________________________________________ Cvs mailing list [email protected] http://lists.mmbase.org/mailman/listinfo/cvs
