Package de.elo.ix.jscript

Class InheritKeywording

java.lang.Object

de.elo.ix.jscript.InheritKeywording

public class InheritKeywording
extends Object

This class provides the default inheritance mechanism for keywording.

Keywording inheritance can be captured by implementing the event IXServerEvents#onInheritKeywording. If this event should process the default inheritance algorithm, instantiate an object of this class and call inherit(Sord, Sord, String[], Object).

Example:

 
 function onInheritKeywording(ec, sord, parent, okeyNames, reserved) {
   var defaultInherit = new InheritKeywording(); 
   var ret = defaultInherit.inherit(sord, parent, okeyNames, reserved);
   return ret;
 }
 
 

Since:

9.00.049.001

Constructor Summary

Constructors

Constructor	Description
InheritKeywording()
InheritKeywording(IInheritKeywordingHandler handler)

Method Summary

Modifier and Type	Method	Description
InheritKeywordingResult	inherit(Sord sord, Sord parentSord, String[] okeyNames, Object reserved)	Inherit keywording.

Methods inherited from class java.lang.Object

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

Constructor Details

InheritKeywording

public InheritKeywording()

InheritKeywording

public InheritKeywording(IInheritKeywordingHandler handler)

Method Details

inherit

public InheritKeywordingResult inherit(Sord sord,
 Sord parentSord,
 String[] okeyNames,
 Object reserved)
                                throws Exception

Inherit keywording.

Parameters:

sord - Child sord that receives keywording from parentSord.

parentSord - Parent sord.

okeyNames - Names of index lines to be inherited.

reserved - Reserved

Returns:

Control value that describes, how to continue processing, see InheritKeywordingResult.

Throws:

Exception