io.github.prolobjectlink.prolog

Interface PrologJavaConverter

All Known Implementing Classes:

AbstractJavaConverter

public interface PrologJavaConverter

Converter for convert PrologTerm to the equivalent Java object taking like reference the following equivalence table.

Equivalence table

Java Object	Prolog Term
null	PrologProvider.prologNil()
String	PrologAtom
Boolean.FALSE	PrologProvider.prologFalse()
Boolean.TRUE	PrologProvider.prologTrue()
Integer	PrologInteger
Float	PrologFloat
Double	PrologDouble
Long	PrologLong
Object[]	PrologList

There are special cases of Java object that can be converted to Prolog equivalent but the inverse case it's not possible. They are Byte, Character, Short that can be converted to PrologInteger using your numeric value. The main problems is that after PrologInteger conversion this value will be converted in Integer.

Since:

1.0

Author:

Jose Zalacain

Method Summary

Modifier and Type	Method and Description
boolean	containQuotes(String functor) Check if the current functor have quotes at the start and end of the given functor.
String	removeQuotes(String functor) Remove functor quotes if they are present.
Object	toObject(PrologTerm term) Create a Java object from given Prolog term.
List<Object>	toObjectList(PrologTerm[] terms) Create a Java objects list from given Prolog term array.
List<List<Object>>	toObjectLists(PrologTerm[][] terms) Create an equivalent list of objects lists using the given Prolog terms matrix.
Map<String,Object>	toObjectMap(Map<String,PrologTerm> map) Create an equivalent Java object map using the given Prolog terms map.
List<Map<String,Object>>	toObjectMaps(Map<String,PrologTerm>[] maps) Create an equivalent Java object map list using the given Prolog terms map array.
Object[]	toObjectsArray(PrologTerm[] terms) Create a Java objects array from given Prolog term array.
PrologTerm	toTerm(Object object) Create an equivalent Prolog term using the given Java object.
PrologTerm[]	toTermsArray(Object[] objects) Create an equivalent Prolog terms array using the given Java objects array.

Method Detail

toObjectMaps

List<Map<String,Object>> toObjectMaps(Map<String,PrologTerm>[] maps)

Create an equivalent Java object map list using the given Prolog terms map array. The resulting map list contains maps that have the same string key and the value for every key is a conversion from Prolog term to Java object.

Parameters:

maps - Prolog terms map list to be converted in Java objects map list.

Returns:

an equivalent Java objects map array using the given Prolog terms map list.

Since:

1.0

toObjectMap

Map<String,Object> toObjectMap(Map<String,PrologTerm> map)

Create an equivalent Java object map using the given Prolog terms map. The resulting map have the same string key and the value for every key is a conversion from Prolog term to Java object.

Parameters:

map - Prolog terms map representation to be converted

Returns:

an equivalent Java object map using the given Prolog terms map.

Since:

1.0

toObjectList

List<Object> toObjectList(PrologTerm[] terms)

Create a Java objects list from given Prolog term array.

Parameters:

terms - Prolog term array to be converted to Java objects array.

Returns:

Java objects list representation from given Prolog term array.

Since:

1.0

toObjectLists

List<List<Object>> toObjectLists(PrologTerm[][] terms)

Create an equivalent list of objects lists using the given Prolog terms matrix.

Parameters:

terms - Prolog terms matrix to be converted

Returns:

an equivalent list of objects lists using the given Prolog terms matrix representation.

Since:

1.0

toObjectsArray

Object[] toObjectsArray(PrologTerm[] terms)

Create a Java objects array from given Prolog term array.

Parameters:

terms - Prolog term array to be converted to Java objects array.

Returns:

Java objects array representation from given Prolog term array.

Since:

1.0

toTermsArray

PrologTerm[] toTermsArray(Object[] objects)

Create an equivalent Prolog terms array using the given Java objects array.

Parameters:

objects - Java objects array representation to be converted

Returns:

an equivalent Prolog terms array using the given Java objects array.

Since:

1.0

toObject

Object toObject(PrologTerm term)

Create a Java object from given Prolog term.

Parameters:

term - Prolog term to be converted to Java object.

Returns:

a Java object from given Prolog term.

Since:

1.0

toTerm

PrologTerm toTerm(Object object)

Create an equivalent Prolog term using the given Java object.

Parameters:

object - Java object to be converted

Returns:

an equivalent Prolog term using the given Java object.

Since:

1.0

containQuotes

boolean containQuotes(String functor)

Check if the current functor have quotes at the start and end of the given functor. Return true if the current functor is enclosing between functors or false in other case.

Parameters:

functor - string functor to be checked

Returns:

true if the current functor is enclosing between functors or false in other case.

Since:

1.0

removeQuotes

String removeQuotes(String functor)

Remove functor quotes if they are present. If the string functor don't have quotes, this method return the functor itself.

Parameters:

functor - string functor to remove quotes if they are present.

Returns:

functor without quotes if they are present. The functor itself if quotes are not present.

Since:

1.0