br.org.scadabr.api.utils

Class APIUtils

java.lang.Object

br.org.scadabr.api.utils.APIUtils

public final class APIUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Calendar	date
private static APIError	error
private static APIError[]	errors
private static java.util.HashMap<java.lang.Integer,java.lang.String>	folderIdToPath
private static java.lang.String	path

Constructor Summary

Constructors

Constructor and Description
APIUtils()

Method Summary

Modifier and Type	Method and Description
private static void	buildErrorArray(ErrorCode code, java.lang.String description)
static boolean	checkCompatibleDataTypes(DataType dataType, java.lang.Object value)
static boolean	checkStringValue(java.lang.String value, DataType dataType)
static java.lang.String	getCompletePath(int folderId, PointHierarchy pH)
static APIError[]	getError()
static java.util.Calendar	getOnlineDate()
static java.lang.String	getVersion()
private static boolean	isEmpty(java.lang.String x)
static boolean	isHigherLevel(AlarmLevel level, AlarmLevel reference)
static boolean	isInPath(java.lang.String item, java.lang.String path)
private static void	searchFolder(PointFolder folder)
static void	setError(APIError[] error)
static void	setError(ErrorCode code, java.lang.String description)
static void	setOnLineDate()
static AlarmLevel	toAlarmLevel(int i)
static java.lang.String	toCondition(PointEventDetectorVO pointEvent)
static DataType	toDataType(int mangoDataType)
static EventDefinition	toEventDefinition(java.lang.String name, int alarmLevel, EventType eventType)
static EventMessage[]	toEventMessage(java.util.List<UserComment> list)
static EventNotification	toEventNotification(EventInstance eventInstance)
static java.lang.String	toScheduledEventConfig(ScheduledEventVO sE)
static UserComment	toUserComment(EventMessage message)
static void	validateAckEventsParams(AckEventsParams params)
static void	validateAnnotateEvent(AnnotateEventParams params)
static void	validateBrowseDataPointsParams(BrowseDataPointsParams params)
static void	validateBrowseDataSourcesParams(BrowseDataSourcesParams params)
static void	validateConfigureDataPointParams(ConfigureDataPointParams params)
static void	validateConfigureDataSourceParams(ConfigureDataSourceParams params)
static void	validateEventsHistoryParams(GetEventsHistoryParams params)
static void	validateGetDataHistoryParams(GetDataHistoryParams params)
static void	validateReadData(ReadDataParams params)
static void	validateRemoveDataPointParams(RemoveDataPointParams params)
static void	validateRemoveDataSourceParams(RemoveDataSourceParams params)
static void	validateStringWriteData(WriteStringDataParams params)
static void	validateWriteData(WriteDataParams params)
static DataType	whatType(java.lang.Object value)

Methods inherited from class java.lang.Object

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

Field Detail

date

private static java.util.Calendar date

errors

private static APIError[] errors

error

private static APIError error

path

private static java.lang.String path

folderIdToPath

private static java.util.HashMap<java.lang.Integer,java.lang.String> folderIdToPath

Constructor Detail

APIUtils

public APIUtils()

Method Detail

getCompletePath

public static java.lang.String getCompletePath(int folderId,
                                               PointHierarchy pH)

checkCompatibleDataTypes

public static boolean checkCompatibleDataTypes(DataType dataType,
                                               java.lang.Object value)

whatType

public static DataType whatType(java.lang.Object value)

checkStringValue

public static boolean checkStringValue(java.lang.String value,
                                       DataType dataType)

searchFolder

private static void searchFolder(PointFolder folder)

validateWriteData

public static void validateWriteData(WriteDataParams params)
                              throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateStringWriteData

public static void validateStringWriteData(WriteStringDataParams params)
                                    throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateReadData

public static void validateReadData(ReadDataParams params)
                             throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateAnnotateEvent

public static void validateAnnotateEvent(AnnotateEventParams params)
                                  throws ScadaBRAPIException

Throws:

ScadaBRAPIException

isEmpty

private static boolean isEmpty(java.lang.String x)

validateAckEventsParams

public static void validateAckEventsParams(AckEventsParams params)
                                    throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateGetDataHistoryParams

public static void validateGetDataHistoryParams(GetDataHistoryParams params)
                                         throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateEventsHistoryParams

public static void validateEventsHistoryParams(GetEventsHistoryParams params)
                                        throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateBrowseDataSourcesParams

public static void validateBrowseDataSourcesParams(BrowseDataSourcesParams params)
                                            throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateConfigureDataSourceParams

public static void validateConfigureDataSourceParams(ConfigureDataSourceParams params)
                                              throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateConfigureDataPointParams

public static void validateConfigureDataPointParams(ConfigureDataPointParams params)
                                             throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateRemoveDataSourceParams

public static void validateRemoveDataSourceParams(RemoveDataSourceParams params)
                                           throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateRemoveDataPointParams

public static void validateRemoveDataPointParams(RemoveDataPointParams params)
                                          throws ScadaBRAPIException

Throws:

ScadaBRAPIException

validateBrowseDataPointsParams

public static void validateBrowseDataPointsParams(BrowseDataPointsParams params)
                                           throws ScadaBRAPIException

Throws:

ScadaBRAPIException

toScheduledEventConfig

public static java.lang.String toScheduledEventConfig(ScheduledEventVO sE)

toCondition

public static java.lang.String toCondition(PointEventDetectorVO pointEvent)

buildErrorArray

private static void buildErrorArray(ErrorCode code,
                                    java.lang.String description)

getError

public static APIError[] getError()

setError

public static void setError(ErrorCode code,
                            java.lang.String description)

setError

public static void setError(APIError[] error)

toEventDefinition

public static EventDefinition toEventDefinition(java.lang.String name,
                                                int alarmLevel,
                                                EventType eventType)

toEventNotification

public static EventNotification toEventNotification(EventInstance eventInstance)

toEventMessage

public static EventMessage[] toEventMessage(java.util.List<UserComment> list)

toDataType

public static DataType toDataType(int mangoDataType)

toUserComment

public static UserComment toUserComment(EventMessage message)

isHigherLevel

public static boolean isHigherLevel(AlarmLevel level,
                                    AlarmLevel reference)

isInPath

public static boolean isInPath(java.lang.String item,
                               java.lang.String path)

setOnLineDate

public static void setOnLineDate()

getOnlineDate

public static java.util.Calendar getOnlineDate()

getVersion

public static final java.lang.String getVersion()

toAlarmLevel

public static AlarmLevel toAlarmLevel(int i)