better comments

This commit is contained in:
Brian Sweeney 2018-04-23 15:04:50 -06:00
parent bb9441faf5
commit 6e20d45c8f
3 changed files with 12 additions and 1 deletions

View File

@ -33,6 +33,8 @@ final class AllDataSourcesCommonFilesAlgorithm extends CommonFilesMetaDataBuilde
* sources. * sources.
* *
* @param dataSourceIdMap a map of obj_id to datasource name * @param dataSourceIdMap a map of obj_id to datasource name
* @param filterByMediaMimeType match only on files whose mime types can be broadly categorized as media types
* @param filterByDocMimeType match only on files whose mime types can be broadly categorized as document types
*/ */
AllDataSourcesCommonFilesAlgorithm(Map<Long, String> dataSourceIdMap, boolean filterByMediaMimeType, boolean filterByDocMimeType) { AllDataSourcesCommonFilesAlgorithm(Map<Long, String> dataSourceIdMap, boolean filterByMediaMimeType, boolean filterByDocMimeType) {
super(dataSourceIdMap, filterByMediaMimeType, filterByDocMimeType); super(dataSourceIdMap, filterByMediaMimeType, filterByDocMimeType);

View File

@ -117,6 +117,13 @@ abstract class CommonFilesMetaDataBuilder {
"application/vnd.oasis.opendocument.text"//NON-NLS "application/vnd.oasis.opendocument.text"//NON-NLS
).collect(Collectors.toSet()); ).collect(Collectors.toSet());
/**
* Subclass this to implement different algorithms for getting common files.
*
* @param dataSourceIdMap a map of obj_id to datasource name
* @param filterByMediaMimeType match only on files whose mime types can be broadly categorized as media types
* @param filterByDocMimeType match only on files whose mime types can be broadly categorized as document types
*/
CommonFilesMetaDataBuilder(Map<Long, String> dataSourceIdMap, boolean filterByMediaMimeType, boolean filterByDocMimeType) { CommonFilesMetaDataBuilder(Map<Long, String> dataSourceIdMap, boolean filterByMediaMimeType, boolean filterByDocMimeType) {
dataSourceIdToNameMap = dataSourceIdMap; dataSourceIdToNameMap = dataSourceIdMap;
filterByMedia = filterByMediaMimeType; filterByMedia = filterByMediaMimeType;

View File

@ -36,7 +36,9 @@ final class SingleDataSource extends CommonFilesMetaDataBuilder {
* *
* @param dataSourceId data source id for which common files must appear at * @param dataSourceId data source id for which common files must appear at
* least once * least once
* @param dataSourceIdMap map of obj_id to data source name * @param dataSourceIdMap a map of obj_id to datasource name
* @param filterByMediaMimeType match only on files whose mime types can be broadly categorized as media types
* @param filterByDocMimeType match only on files whose mime types can be broadly categorized as document types
*/ */
SingleDataSource(Long dataSourceId, Map<Long, String> dataSourceIdMap, boolean filterByMediaMimeType, boolean filterByDocMimeType) { SingleDataSource(Long dataSourceId, Map<Long, String> dataSourceIdMap, boolean filterByMediaMimeType, boolean filterByDocMimeType) {
super(dataSourceIdMap, filterByMediaMimeType, filterByDocMimeType); super(dataSourceIdMap, filterByMediaMimeType, filterByDocMimeType);