The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
The Link programming interface is an object-oriented approach that enables applications to invoke HCL Link maps, thus removing reliance on command lines.
The Link programming interface is based on map, card, adapter, connection, and stream objects.
The Link programming interface creates a map object instance from the byte array representing a compiled map file. The hierarchies of map, card and adapter objects are created by this method.
The map object methods are defined by the map object.
This method returns the handle to the specified input card.
The Link programming interface map, card, and adapter object properties define the properties that can be set for each object. Use these methods to GET or SET the object properties.
The Link programming interface objects have a relationship to each other defined by a specific hierarchy.
The Link programming interface methods provide a means to query or modify properties of objects.
Properties can be set and their values can be obtained by executing the methods defined by the map object.
This method returns the number of input cards.
This method returns the number of output cards.
This method returns the handle to the specified output card.
The card object is an abstraction of a card in a map.
An adapter object is created for each card when a map instance object is created.
Use the Link programming interface to load, run and control maps.
The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
Use the Python API to create, edit, and run maps and schemas from a Python program. For details, see the documentation installed in install_dir/python/api/hip/docs/html/index.html. Examples of the Python API are installed in install_dir/python/api/examples. Documentation for the Python API examples is available in install_dir/python/api/docs/html/examples.html.
The Java API interfaces enable you to create, edit, and run maps and schemas from a Java™ program.
The Java™ Tools provide objects and JNI utilities that you can use to get information about your map instances.