Business Objects
Quark Platform Documentation
Version 1.7.0_0
Business Objects

org.openquark.gems.client
Class AutoburnLogic.AutoburnInfo

java.lang.Object
  extended by org.openquark.gems.client.AutoburnLogic.AutoburnInfo
Enclosing class:
AutoburnLogic

public static class AutoburnLogic.AutoburnInfo
extends Object

A helper class to hold the status of a query as to whether a particular connection between gems can be made, including the possibility of various sorts of burning.

Author:
Bo Ilic

Method Summary
 AutoburnLogic.AutoburnUnifyStatus getAutoburnUnifyStatus()
           
 List<AutoburnLogic.BurnCombination> getBurnCombinations()
           
 int getMaxTypeCloseness()
           
 int getNoBurnTypeCloseness()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getAutoburnUnifyStatus

public AutoburnLogic.AutoburnUnifyStatus getAutoburnUnifyStatus()
Returns:
a summary of the type of unifications possible (including the possibility of burning).

getBurnCombinations

public List<AutoburnLogic.BurnCombination> getBurnCombinations()
Returns:
each element of this list is a BurnCombination which indicate which arguments should be burnt.

getMaxTypeCloseness

public int getMaxTypeCloseness()
Returns:
every possible configuration of burnings (e.g. for a gem with 2 arguments, can burn none of the arguments, the first argument only, the second argument only, or both arguments) has an associated type closeness for its unification with the destination type. This is the maximum value and represents the "best possible" connection.

getNoBurnTypeCloseness

public int getNoBurnTypeCloseness()
Returns:
the type closeness for the case where no burning occurs. This is used by clients to see if the no burning situation is the most "natural" and we shouldn't bother presenting autoburn possibilities.

Business Objects
Quark Platform Documentation
Version 1.7.0_0
Business Objects

Copyright © 2007 Business Objects. All rights reserved.