java.lang.Object

de.swa.fuh.qrefinement.qrm.RefinementCollection

public class RefinementCollection
extends java.lang.Object

Class representing the collection of all assets

Author:: Nicolas Boch

Method Summary

Modifier and Type	Method	Description
`static void`	`clear()`	set the single instance of this class to null.
`java.util.Hashtable<MMFG,GraphCode>`	`getCache()`
`java.util.Vector<MMFG>`	`getCollection()`	returns the collection of MMFGs
`java.util.Vector<GraphCode>`	`getCollectionGraphCodes()`	returns a vector of all collection's Graph Codes
`GraphCode`	`getCurrentQuery()`	returns the last executed query
`static RefinementCollection`	`getInstance()`	singleton pattern access
`java.lang.String`	`getName()`	returns the collection name
`GraphCode`	`getOrGenerateGraphCode(MMFG mmfg)`	returns or generates a Graph Code for a given MMFG
`java.util.Vector<MMFG>`	`getRecommendedAssets(GraphCode gcQuery)`	returns recommended assets based on a Graph Code query
`java.util.Hashtable<java.io.File,AssetRectangles>`	`getRelevanceMarks()`	Returns the mapping of image assets to relevance marks
`java.util.Vector<MMFG>`	`getSimilarAssets(GraphCode gcQuery)`	returns similar assets based on a Graph Code query
`java.util.Hashtable<java.io.File,AssetTextMarks>`	`getTextRelevanceMarks()`	Returns the mapping of text assets to relevance marks
`void`	`init()`	Initializes the mapping of asset files to relevance marks
`void`	`query(GraphCode gcQuery)`	executes a query
`void`	`queryVRM(GraphCode gcQuery)`
`void`	`setCurrentQuery(GraphCode gc)`
`static void`	`setInstance(MMFGCollection coll)`	initialize the single instance of this class by cloning an existing collection of assets

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- getInstance
  
  public static RefinementCollection getInstance()
  
  singleton pattern access
- setInstance
  
  public static void setInstance(MMFGCollection coll)
  
  initialize the single instance of this class by cloning an existing collection of assets
  
  Parameters:
  
  coll -
- clear
  
  public static void clear()
  
  set the single instance of this class to null. Should be called when closing the refinement application but not exiting the whole GMAF application.
- init
  
  public void init()
  
  Initializes the mapping of asset files to relevance marks
- getRelevanceMarks
  
  public java.util.Hashtable<java.io.File,AssetRectangles> getRelevanceMarks()
  
  Returns the mapping of image assets to relevance marks
- getTextRelevanceMarks
  
  public java.util.Hashtable<java.io.File,AssetTextMarks> getTextRelevanceMarks()
  
  Returns the mapping of text assets to relevance marks
- getCollection
  
  public java.util.Vector<MMFG> getCollection()
  
  returns the collection of MMFGs
- getName
  
  public java.lang.String getName()
  
  returns the collection name
- getCurrentQuery
  
  public GraphCode getCurrentQuery()
  
  returns the last executed query
- getCollectionGraphCodes
  
  public java.util.Vector<GraphCode> getCollectionGraphCodes()
  
  returns a vector of all collection's Graph Codes
- getOrGenerateGraphCode
  
  public GraphCode getOrGenerateGraphCode(MMFG mmfg)
  
  returns or generates a Graph Code for a given MMFG
- getSimilarAssets
  
  public java.util.Vector<MMFG> getSimilarAssets(GraphCode gcQuery)
  
  returns similar assets based on a Graph Code query
- getRecommendedAssets
  
  public java.util.Vector<MMFG> getRecommendedAssets(GraphCode gcQuery)
  
  returns recommended assets based on a Graph Code query
- setCurrentQuery
  
  public void setCurrentQuery(GraphCode gc)
- getCache
  
  public java.util.Hashtable<MMFG,GraphCode> getCache()
- query
  
  public void query(GraphCode gcQuery)
  
  executes a query
- queryVRM
  
  public void queryVRM(GraphCode gcQuery)

Class RefinementCollection

Method Summary

Methods inherited from class java.lang.Object

Method Details