|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Graph
Interface representing a social network. Users are the individuals consuming music, artists are the artists producing music, userlinks are the links between users (with some name or class attached to them), artistlinks are the links between users and artists, and similar artists are the links between different artists.
Method Summary | |
---|---|
void |
add(Actor u)
Add a user to the graph. |
void |
add(Graph g)
Add a graph (g) to the graph. |
void |
add(Link link)
Adds a userlink to the graph. |
void |
add(PathSet pathSet)
Add a PathSet to this graph. |
void |
add(Property prop)
Add a property to this graph. |
void |
addChild(Graph g)
Set the given graph to be a child of the current graph. |
void |
anonymize()
Replaces all actor IDs with an anonymous numeric ID. |
void |
close()
Close database connections or write to file. |
void |
commit()
Commit the contents to database or storage. |
java.util.List<Actor> |
getActor()
Retrieve an array of all actors of all types. |
java.util.List<Actor> |
getActor(java.lang.String type)
Retrieve an array of all actors of a given type. |
Actor |
getActor(java.lang.String type,
java.lang.String ID)
Retrieve the users that has the given ID. |
int |
getActorCount(java.lang.String mode)
Returns the number of actors of the given type |
java.util.Iterator<Actor> |
getActorIterator()
|
java.util.Iterator<Actor> |
getActorIterator(java.lang.String type)
Create a read only iterator over all actors. |
java.util.List<java.lang.String> |
getActorTypes()
List all types - returns null if no actors exist. |
java.util.List<Graph> |
getChildren()
Returns the children graphs of this object or null if none exist |
Graph |
getChildren(java.lang.String id)
Returns the children graph with the given id or null if there is not a child with that name. |
java.util.Iterator<Graph> |
getChildrenIterator()
|
java.lang.String |
getID()
Return the ID associated with this Graph |
java.util.List<Link> |
getLink()
Return all user to user links in this graph in an array. |
java.util.List<Link> |
getLink(java.lang.String type)
Retrieve an array of all userlinks of the given type from this graph or null if no such links are in this graph. |
java.util.List<Link> |
getLink(java.lang.String type,
Actor sourceActor,
Actor destActor)
Returns all links of the given type (relation) type going from actor sourceActor to actor destActor or null. |
java.util.Iterator<Link> |
getLinkByDesinationIterator(java.lang.String type,
Actor destActor)
|
java.util.List<Link> |
getLinkByDestination(java.lang.String type,
Actor destActor)
Returns all links (edges, arcs) of type (relation) type that point to the given actor. |
java.util.List<Link> |
getLinkBySource(java.lang.String type,
Actor sourceActor)
Returns all links (edges, arcs) of type (relation) type that go from the given actor to any destination. |
java.util.Iterator<Link> |
getLinkBySourceIterator(java.lang.String type,
Actor sourceActor)
|
java.util.Iterator<Link> |
getLinkIterator()
|
java.util.Iterator<Link> |
getLinkIterator(java.lang.String type)
|
java.util.Iterator<Link> |
getLinkIterator(java.lang.String type,
Actor sourceActor,
Actor destActor)
|
java.util.List<java.lang.String> |
getLinkTypes()
Returns all link types currently in this graph or null if no links are present. |
Properties |
getParameter()
Obtain a computer-readable description of the parameters and options this graph supports |
Parameter |
getParameter(java.lang.String name)
|
Graph |
getParent()
Returns the parent graph of this object or null if this is a root graph |
java.util.List<PathSet> |
getPathSet()
Return all PathSets associated with this graph. |
PathSet |
getPathSet(java.lang.String id)
Return the named PathSet. |
java.util.Iterator<PathSet> |
getPathSetIterator()
|
java.util.List<Property> |
getProperty()
Returns an array of all properties associated with this object or null if none exist |
Property |
getProperty(java.lang.String type)
Return a property named by the given string or null if no property by this name exists |
java.util.Iterator<Property> |
getPropertyIterator()
|
void |
init(Properties props)
Set the parameters of this graph from the following property object. |
Graph |
prototype()
|
void |
remove(Actor u)
Identifies the given user and removes it and all links involving it from the graph. |
void |
remove(Link ul)
remove all user links with the same type, user ID, and artist ID from the graph |
void |
removeProperty(java.lang.String ID)
|
void |
setID(java.lang.String id)
Set this graph's ID to this value. |
Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Model |
---|
addListener |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Method Detail |
---|
void add(Actor u)
u
- user to be included in the graph.void add(Link link)
link
- description of a named link between two usersvoid remove(Actor u)
u
- user to be removed from the graph.void remove(Link ul)
ul
- link to be removed from the graph.Actor getActor(java.lang.String type, java.lang.String ID)
type
- ID
- ID string identifying an user
java.util.List<Actor> getActor()
java.util.Iterator<Actor> getActorIterator()
java.util.List<Actor> getActor(java.lang.String type)
type
- class of actor to return
java.util.Iterator<Actor> getActorIterator(java.lang.String type)
type
- type (mode) of actor to return
java.util.List<java.lang.String> getActorTypes()
java.util.List<Link> getLink()
java.util.Iterator<Link> getLinkIterator()
java.util.List<Link> getLink(java.lang.String type)
type
-
java.util.Iterator<Link> getLinkIterator(java.lang.String type)
java.util.List<Link> getLinkBySource(java.lang.String type, Actor sourceActor)
type
- type (relation) of link to returnsourceActor
- starting point of the link
java.util.Iterator<Link> getLinkBySourceIterator(java.lang.String type, Actor sourceActor)
java.util.List<Link> getLinkByDestination(java.lang.String type, Actor destActor)
type
- type (relation) of link to returndestActor
- actor pointed to by links
java.util.Iterator<Link> getLinkByDesinationIterator(java.lang.String type, Actor destActor)
java.util.List<Link> getLink(java.lang.String type, Actor sourceActor, Actor destActor)
type
- type (relation) of the link to returnsourceActor
- starting point of the linkdestActor
- actor pointed to by links
java.util.Iterator<Link> getLinkIterator(java.lang.String type, Actor sourceActor, Actor destActor)
java.util.List<java.lang.String> getLinkTypes()
java.util.List<Property> getProperty()
java.util.Iterator<Property> getPropertyIterator()
void removeProperty(java.lang.String ID)
Property getProperty(java.lang.String type)
type
- property's name
void add(Property prop)
prop
- property to be added.java.util.List<PathSet> getPathSet()
java.util.Iterator<PathSet> getPathSetIterator()
PathSet getPathSet(java.lang.String id)
id
- ID of the PathSet to return
void add(PathSet pathSet)
pathSet
- PathSet to be added to this graphvoid setID(java.lang.String id)
id
- graph IDjava.lang.String getID()
void commit()
void add(Graph g)
g
- graph to be addedvoid close()
void anonymize()
Graph getParent()
java.util.List<Graph> getChildren()
java.util.Iterator<Graph> getChildrenIterator()
Graph getChildren(java.lang.String id)
id
- ID of the graph to return
void addChild(Graph g)
g
- Child GraphProperties getParameter()
Parameter getParameter(java.lang.String name)
void init(Properties props)
props
- properties to be setint getActorCount(java.lang.String mode)
mode
- type of actor to query
Graph prototype()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |