com.graphaware.reco.generic.engine.TopLevelDelegatingRecommendationEngine Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of recommendation-engine Show documentation
Show all versions of recommendation-engine Show documentation
Skeleton for a Recommendation Engine
The newest version!
/*
* Copyright (c) 2013-2016 GraphAware
*
* This file is part of the GraphAware Framework.
*
* GraphAware Framework 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 3 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, see
* extends DelegatingRecommendationEngine implements TopLevelRecommendationEngine {
private final List> blacklistBuilders = new LinkedList<>();
private final List> filters = new LinkedList<>();
private final List> loggers = new LinkedList<>();
/**
* Create a new engine.
*/
public TopLevelDelegatingRecommendationEngine() {
super();
addBlacklistBuilders(blacklistBuilders());
addFilters(filters());
addLoggers(loggers());
}
/**
* {@inheritDoc}
*/
@Override
public final Context produceContext(IN input, Config config) {
Set blacklist = new HashSet<>();
for (BlacklistBuilder blacklistBuilder : blacklistBuilders) {
blacklist.addAll(blacklistBuilder.buildBlacklist(input, config));
}
return produceContext(input, config, unmodifiableList(filters), blacklist);
}
/**
* Produce a {@link com.graphaware.reco.generic.context.Context} for the recommendation-computing process.
*
* @param input for which recommendations are about to be computed.
* @param config for the computation. Must not be null.
* @param filters for filtering out items.
* @param blacklist for blaclisting items.
* @return context.
*/
protected FilteringContext produceContext(IN input, Config config, List> filters, Set blacklist) {
return new FilteringContext<>(input, config, filters, blacklist);
}
/**
* {@inheritDoc}
*/
@Override
public List> recommend(IN input, Config config) {
return produceAndLogRecommendations(input, produceContext(input, config));
}
private List> produceAndLogRecommendations(IN input, Context context) {
List> recommendations = recommend(input, context).get(context.config().limit());
for (Logger logger : loggers) {
logger.log(input, recommendations, context);
}
return recommendations;
}
/**
* {@inheritDoc}
*
* Only delegates to subclass, overridden to be made final.
*/
@Override
public final Recommendations doRecommend(IN input, Context context) {
return super.doRecommend(input, context);
}
/**
* Add a {@link com.graphaware.reco.generic.filter.BlacklistBuilder} used by this factory to produce blacklists of items.
*
* @param blacklistBuilder to be used. Must not be null.
*/
public final void addBlacklistBuilder(BlacklistBuilder blacklistBuilder) {
notNull(blacklistBuilder);
blacklistBuilders.add(blacklistBuilder);
}
/**
* Add {@link com.graphaware.reco.generic.filter.BlacklistBuilder}s used by this factory to produce blacklists of items.
*
* @param blacklistBuilders to be used. Must not be null and all of the elements must not be null.
*/
public final void addBlacklistBuilders(List> blacklistBuilders) {
notNull(blacklistBuilders);
for (BlacklistBuilder blacklistBuilder : blacklistBuilders) {
addBlacklistBuilder(blacklistBuilder);
}
}
/**
* Add a {@link com.graphaware.reco.generic.filter.Filter} passed to the produced {@link com.graphaware.reco.generic.context.Context}s.
*
* @param filter to be used. Must not be null.
*/
public final void addFilter(Filter filter) {
notNull(filter);
filters.add(filter);
}
/**
* Add {@link com.graphaware.reco.generic.filter.Filter}s passed to the produced {@link com.graphaware.reco.generic.context.Context}s.
*
* @param filters to be used. Must not be null and all of the elements must not be null.
*/
public final void addFilters(List> filters) {
notNull(filters);
for (Filter filter : filters) {
addFilter(filter);
}
}
/**
* Get {@link com.graphaware.reco.generic.log.Logger}s to use for recording / logging produced recommendations. Designed to be overridden.
*
* @return empty list by default.
*/
protected List> loggers() {
return Collections.emptyList();
}
/**
* Add a {@link com.graphaware.reco.generic.log.Logger} that this engine logs to.
*
* @param logger to use. Must not be null.
*/
public final void addLogger(Logger logger) {
notNull(logger);
loggers.add(logger);
}
/**
* Add {@link com.graphaware.reco.generic.log.Logger}s that this engine logs to, in the order
* in which they are added.
*
* @param loggers to use. Must not be null and all of the elements must not be null.
*/
public final void addLoggers(List> loggers) {
notNull(loggers);
for (Logger logger : loggers) {
addLogger(logger);
}
}
}