Helper AbstractSpecial

Jan Burse, created Aug 17. 2019
package jekpro.model.inter;
import jekpro.model.molec.EngineMessage;
import jekpro.model.pretty.AbstractSource;
import jekpro.reference.reflect.SpecialForeign;
import jekpro.tools.array.AbstractDelegate;
import jekpro.tools.term.SkelAtom;
import jekpro.tools.term.SkelCompound;
/**
* <p>Provides the base class for built-in predicates.</p>
* <p/>
* Warranty & Liability
* To the extent permitted by applicable law and unless explicitly
* otherwise agreed upon, XLOG Technologies GmbH makes no warranties
* regarding the provided information. XLOG Technologies GmbH assumes
* no liability that any problems might be solved with the information
* provided by XLOG Technologies GmbH.
* <p/>
* Rights & License
* All industrial property rights regarding the information - copyright
* and patent rights in particular - are the sole property of XLOG
* Technologies GmbH. If the company was not the originator of some
* excerpts, XLOG Technologies GmbH has at least obtained the right to
* reproduce, change and translate the information.
* <p/>
* Reproduction is restricted to the whole unaltered document. Reproduction
* of the information is only allowed for non-commercial uses. Selling,
* giving away or letting of the execution of the library is prohibited.
* The library can be distributed as part of your applications and libraries
* for execution provided this comment remains unchanged.
* <p/>
* Restrictions
* Only to be distributed with programs that add significant and primary
* functionality to the library. Not to be distributed with additional
* software intended to replace any components of the library.
* <p/>
* Trademarks
* Jekejeke is a registered trademark of XLOG Technologies GmbH.
*/
public abstract class AbstractSpecial extends AbstractDelegate {
public static final String OP_ILLEGAL_SPECIAL = "illegal special";
protected final int id;
/**
* <p>Create a special.</p>
*
* @param i The id of the special.
*/
protected AbstractSpecial(int i) {
id = i;
}
/**
* <p>Shrink this predicate from the store for a source.</p>
*
* @param pick The predicate.
* @param scope The source.
*/
public final void shrinkPredicate(Predicate pick, AbstractSource scope) {
/* do nothing */
}
/**
* <p>Release this predicate from the store.</p>
*
* @param pick The predicate.
*/
public final void releasePredicate(Predicate pick) {
/* do nothing */
}
/***************************************************************/
/* Special Predicates */
/***************************************************************/
/**
* <p>Compute a hash code.</p>
*
* @return The hash code of this delegate.
*/
public int hashCode() {
return getClass().getName().hashCode() ^ id;
}
/**
* <p>Compare with another delegate.</p>
*
* @param o The other delegate.
* @return True if this delegate equals the other delegate, otherwise false.
*/
public boolean equals(Object o) {
if (!(o instanceof AbstractSpecial))
return false;
AbstractSpecial dp = (AbstractSpecial) o;
return getClass() == dp.getClass() && id == dp.id;
}
/**
* <p>Generate the spec of this delegate.</p>
*
* @param source The source, non null.
* @return The spec.
* @throws EngineMessage Shit happens.
*/
public Object toSpec(AbstractSource source)
throws EngineMessage {
return new SkelCompound(new SkelAtom("special"),
SpecialForeign.classToName(getClass(), source),
Integer.valueOf(id));
}
/***************************************************************/
/* Foreign Predicates */
/***************************************************************/
/**
* <p>Retrieve a name guess.</p>
*
* @return The name guess, or null.
*/
public String getFun() {
return null;
}
/**
* <p>Retrieve an length guess.</p>
*
* @return The length guess, or -1.
*/
public int getArity() {
return -1;
}
}

Comments