biz.c24.io.api.transform
Class StopFilter

java.lang.Object
  extended by biz.c24.io.api.transform.Map
      extended by biz.c24.io.api.transform.StopFilter

public abstract class StopFilter
extends Map

Class responsible for stopping a transformation if an error message should be printed


Nested Class Summary
 
Nested classes/interfaces inherited from class biz.c24.io.api.transform.Map
Map.CollectionArgFunction, Map.FirstCollectionArgFunction, Map.Function
 
Field Summary
protected  Object errorMessage
           
 
Fields inherited from class biz.c24.io.api.transform.Map
ABS, ADD, ADDCOMMENT, ADDNS, ADJUSTTIMEZONE, ADLER32, AFTER, ANCESTOR, AND, AND3, AND4, ARCCOS, ARCSIN, ARCTAN, ARCTAN2, BEFORE, BINARYSEARCH, BITWISEAND, BITWISECOMPLEMENT, BITWISEOR, BITWISEXOR, CALENDAR, CAST, CEIL, CHARAT, CHARFOR, CHARLIST, CHGDAYS, CHGHOURS, CHGMINS, CHGMONTHS, CHGMSECS, CHGSECS, CHGYEARS, COLLAPSEWHITESPACE, COMPARE, CONCAT, CONTAINS, CONVERTDATE, COS, CRC32, DATE2MSECS, DATEFROMSTRING, DATETOSTRING, DATETOSTRINGTZ, DELSUBSTRING, DESERIALIZE, DIFFERENCE, DIVIDE, E, ENDSWITH, EQUALS, EQUALSIGNORECASE, EVEN, EXISTS, EXP, FIRST, FLOOR, FROMBASE64, FROMBLOB, FROMBYTES, FROMCLOB, FROMHEX, FROMSTRING, GETBYTES, GETCLIENTPROPERTY, GETCLIENTPROPERTYKEYS, GETCOMMENTS, GETDAYS, GETHOURS, GETJVMPROPERTY, GETMINS, GETMONTHS, GETMSECS, GETNSPREFIX, GETNSPREFIXES, GETNSURI, GETNSURIS, GETPI, GETPIKEYS, GETSECS, GETTIMEZONEID, GETTRANSFORMPROPERTY, GETYEARS, GREATERTHAN, GREATERTHANOREQUAL, GZIP, IF, IFEXISTS, INDEXOF, INSERT, INSERTINDEX, INSTANCE, INTERSECTION, KEEPALPHA, KEEPALPHANUMERIC, KEEPNUMERIC, LAST, LASTINDEXOF, LASTPOSITIONOF, LENGTH, LESSTHAN, LESSTHANOREQUAL, LOG, LOGEVENT, MATCHES, MAX, MAXLIST, MIN, MINLIST, MOD, MULTIPLY, NOT, NOTEQUALS, NOTEXISTS, NOW, ODD, ONLY_NULL_LIST, OR, OR3, OR4, PAD, PARENT, PI, POSITIONOF, POW, PRODUCT, PUTCLIENTPROPERTY, PUTJVMPROPERTY, PUTPI, PUTTRANSFORMPROPERTY, RANDOM, REMOVE, REMOVECLIENTPROPERTY, REMOVECOMMENT, REMOVEINDEX, REMOVENSPREFIX, REMOVENSURI, REMOVEPI, REPLACEALL, REPLACECHAR, REPLACEFIRST, REPLACEWHITESPACE, REVERSE, ROOT, ROTATE, ROUND, SERIALIZE, SETDOCTYPENAME, SETDOCTYPEPUBLICID, SETDOCTYPESYSTEMID, SETNONAMESPACESCHEMALOCATION, SETSCHEMALOCATION, SETTIMEZONE, SHUFFLE, SIN, SIZE, SORT, SPLIT, SQRT, STARTSWITH, SUBLIST, SUBSTRING, SUBTRACT, SUM, TAN, TIME_ZONE_GMT, TOBASE64, TOBLOB, TOBYTES, TOCLOB, TODEGREES, TOHEX, TOLOWERCASE, TORADIANS, TOSTRING, TOUPPERCASE, TRIM, UNGZIP, UNION, UNPAD, UNZIP, WRAP, XOR, XPATH, ZIP
 
Constructor Summary
StopFilter()
           
 
Method Summary
 Object getError()
          Retrieves the error message
 boolean hasErrorMessage()
          Checks wether the StopFunction returned with an error.
 void setError(String name, Object message)
          Sets the error message
abstract  Object stop(Object obj, Object[] args)
          Stops the transformation from executing when an error message should be printed.
 
Methods inherited from class biz.c24.io.api.transform.Map
appendObject, appendReturnObject, booleanOrValue, combinations, createInArr, createLogEntry, createLogEntry, createLogEntry, createLogEntry, createLogEntry, createOutArr, createOutArr, dateTimeAdder, dateTimeGetter, filter, filter, functionAbs, functionAdd, functionAddComment, functionAddNs, functionAdjustTimeZone, functionAdler32, functionAfter, functionAncestor, functionAnd, functionAnd3, functionAnd4, functionArcCos, functionArcSin, functionArcTan, functionArcTan2, functionBefore, functionBinarySearch, functionBitwiseAnd, functionBitwiseComplement, functionBitwiseOr, functionBitwiseXor, functionCast, functionCeil, functionCharAt, functionCharFor, functionChgDays, functionChgHours, functionChgMins, functionChgMonths, functionChgMsecs, functionChgSecs, functionChgYears, functionCollapseWhitespace, functionCompare, functionConcat, functionContains, functionConvertDate, functionCos, functionCRC32, functionDate2Msecs, functionDateFromString, functionDateToString, functionDateToStringTZ, functionDelSubstring, functionDeserialize, functionDifference, functionDivide, functionE, functionEndsWith, functionEquals, functionEqualsIgnoreCase, functionEven, functionExists, functionExp, functionFirst, functionFloor, functionFromBase64, functionFromBlob, functionFromBytes, functionFromClob, functionFromHex, functionFromString, functionGetBytes, functionGetClientProperty, functionGetClientPropertyKeys, functionGetComments, functionGetDays, functionGetHours, functionGetJvmProperty, functionGetMins, functionGetMonths, functionGetMsecs, functionGetNsPrefix, functionGetNsPrefixes, functionGetNsUri, functionGetNsUris, functionGetPi, functionGetPiKeys, functionGetSecs, functionGetTimeZoneId, functionGetTransformProperty, functionGetYears, functionGreaterThan, functionGreaterThanOrEqual, functionGzip, functionIf, functionIfExists, functionIndexOf, functionInsert, functionInsertIndex, functionInstance, functionIntersection, functionKeepAlpha, functionKeepAlphaNumeric, functionKeepNumeric, functionLast, functionLastIndexOf, functionLastPositionOf, functionLength, functionLessThan, functionLessThanOrEqual, functionLog, functionLogEvent, functionMatches, functionMax, functionMaxList, functionMin, functionMinList, functionMod, functionMultiply, functionNot, functionNotEquals, functionNotExists, functionNow, functionOdd, functionOr, functionOr3, functionOr4, functionPad, functionParent, functionPi, functionPositionOf, functionPow, functionProduct, functionPutClientProperty, functionPutJvmProperty, functionPutPi, functionPutTransformProperty, functionRandom, functionRemove, functionRemoveClientProperty, functionRemoveComment, functionRemoveIndex, functionRemoveNsPrefix, functionRemoveNsUri, functionRemovePi, functionReplaceAll, functionReplaceChar, functionReplaceFirst, functionReplaceWhitespace, functionReverse, functionRoot, functionRotate, functionRound, functionSerialize, functionSetDocTypeName, functionSetDocTypePublicId, functionSetDocTypeSystemId, functionSetNoNamespaceSchemaLocation, functionSetSchemaLocation, functionSetTimeZone, functionShuffle, functionSin, functionSize, functionSort, functionSplit, functionSqrt, functionStartsWith, functionSubList, functionSubstring, functionSubtract, functionSum, functionTan, functionToBase64, functionToBlob, functionToBytes, functionToCharList, functionToClob, functionToDegrees, functionToHex, functionToLowerCase, functionToRadians, functionToString, functionToUpperCase, functionTrim, functionUngzip, functionUnion, functionUnpad, functionUnzip, functionWrap, functionXor, functionXPath, functionZip, getLog, getMaps, getProperties, hashtable, multiTransform, newNumber, newNumber, nullList, parametersAddComment, parametersAddNs, parametersAdjustTimeZone, parametersAncestor, parametersBinarySearch, parametersCharAt, parametersChgDays, parametersChgHours, parametersChgMins, parametersChgMonths, parametersChgMsecs, parametersChgSecs, parametersChgYears, parametersContains, parametersDateFromString, parametersDateToString, parametersDateToStringTZ, parametersDelSubstring, parametersEndsWith, parametersFromBytes, parametersGetBytes, parametersGetClientProperty, parametersGetJvmProperty, parametersGetNsPrefix, parametersGetNsUri, parametersGetPi, parametersGetTransformProperty, parametersIf, parametersIfExists, parametersIndexOf, parametersInsert, parametersInsertIndex, parametersInstance, parametersLastIndexOf, parametersLastPositionOf, parametersLogEvent, parametersMatches, parametersPad, parametersPositionOf, parametersPutClientProperty, parametersPutJvmProperty, parametersPutPi, parametersPutTransformProperty, parametersRemove, parametersRemoveClientProperty, parametersRemoveComment, parametersRemoveIndex, parametersRemoveNsPrefix, parametersRemoveNsUri, parametersRemovePi, parametersReplaceAll, parametersReplaceChar, parametersReplaceFirst, parametersRotate, parametersSetDocTypeName, parametersSetDocTypePublicId, parametersSetDocTypeSystemId, parametersSetNoNamespaceSchemaLocation, parametersSetSchemaLocation, parametersSetTimeZone, parametersSplit, parametersStartsWith, parametersSubList, parametersSubstring, parametersToBytes, parametersUnpad, parametersWrap, parametersXPath, parametersZip, parseDate, register, resolve, resolve, resolveAttribute, resolveElement, setLog, setProperties, stop, transform, transform, value
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

errorMessage

protected Object errorMessage
Constructor Detail

StopFilter

public StopFilter()
Method Detail

stop

public abstract Object stop(Object obj,
                            Object[] args)
                     throws ValidationException
Stops the transformation from executing when an error message should be printed.

Parameters:
obj - The object that needs to be tested.
args - The arguments to use in the evaluation.
Throws:
AbsentDataException - If a required input is not supplied or a required output is not populated.
ValidationException - If the inputs are invalid and Transform.isValidateInputs() returns true.

hasErrorMessage

public boolean hasErrorMessage()
Checks wether the StopFunction returned with an error.

Returns:
true if the function should print an error

getError

public Object getError()
Retrieves the error message

Returns:
the Object representing the error message

setError

public void setError(String name,
                     Object message)
Sets the error message



C24 Technologies © 2002-2012: All Rights Reserved.