org.reco4j.graph.IGraph Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reco4j-core Show documentation

Reco4j is an open source project aims at developing a recommendation framework based on graph data sources. We choose graph databases for several reasons. They are NoSQL databases, so "schemaless". This means that it is possible to extend the basic data structure with intermediate information, i.e. similarity value between item and so on. Moreover, since every information is expressed with properties, nodes and relations, the recommendation process can be customized to work on every graph. Reco4j can be used on every graph where "user" and "item" is represented by node and the preferences are modelled as relationship between them. Current implementation leverage on Neo4j as first graph database integrated in our framework.

The newest version!

/*
 * IGraph.java
 * 
 * Copyright (C) 2013 Alessandro Negro 
 *
 * 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 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 .
 */
package org.reco4j.graph;

import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.mahout.cf.taste.impl.common.FastIDSet;

/**
 * This interface represents a Graph. Subclass of this instance can use different
 * mechanism to handle the graph data (for instance: neo4j, infiniteGraph, dbms).
 * Also the rank is represented as a link between the party and the object ranked
 ** @author Alessandro Negro 
 */
public interface IGraph
{
  public INode addNode(Map properties);
  public void setNodeProperty(INode node, String propertyName, String value);
  
  public void addEdge(INode x, INode y, IEdgeType similarityEdgeType, String propertyName, String value);
  public void setEdgeProperty(IEdge edge, String propertyName, String value);
  
  public List getNodesByInEdge(IEdgeType edgesType);
  public List getNodesByType(String type);
  public void getNodesByType(String type, IGraphCallable callback);
  public ConcurrentHashMap getNodesMapByType(String type);
  public List getEdgesByType(IEdgeType edgesType);
  
  public INode getUserNodeById(long id);
  public INode getItemNodeById(long id);
  public INode getNodeById(long id);
  
  public int getNodesNumberByType(String type);
  
  public FastIDSet getEdgesIdByType(IEdgeType edgeType);
  public FastIDSet getNodesIdByType(String type);
}