org.openepics.cable.util.fbs

Class FbsUtil

java.lang.Object

org.openepics.cable.util.fbs.FbsUtil

public class FbsUtil
extends Object

Utility class to convert, extract, list, get FBS tag and associated information.

Class does NOT retrieve information.

Author:

Lars Johansson, Zoltan Runyo

See Also:

FbsElement

Method Summary

Modifier and Type	Method and Description
static FbsElement	getFbsElementForCableName(Collection<FbsElement> fbsElements, String cableName) Extract FbsElement that correspond to given cable name (exact match).
static FbsElement	getFbsElementForEssName(Collection<FbsElement> fbsElements, String essName) Extract FbsElement that correspond to given ESS name (exact match).
static FbsElement	getFbsElementForId(Collection<FbsElement> fbsElements, String id) Extract FbsElement that correspond to given id (exact match).
static FbsElement	getFbsElementForTag(Collection<FbsElement> fbsElements, String tag) Extract FbsElement that correspond to given tag (exact match).
static List<FbsElement>	getFbsElementsForCableName(Collection<FbsElement> fbsElements, String cableName) Extract list of FbsElement that correspond to given cable name (exact match).
static List<FbsElement>	getFbsElementsForEssName(Collection<FbsElement> fbsElements, String essName) Extract list of FbsElement that correspond to given ESS name (exact match).
static List<FbsElement>	getFbsElementsForId(Collection<FbsElement> fbsElements, String id) Extract list of FbsElement that correspond to given id (exact match).
static List<FbsElement>	getFbsElementsForTag(Collection<FbsElement> fbsElements, String tag) Extract list of FbsElement that correspond to given tag (exact match).
static Map<String,FbsElement>	readMappingsCableNameToFbsElement(List<FbsElement> fbsElements) Converts a FbsElement list into a map with entries (key, value - cable name, FbsElement).
static Map<String,String>	readMappingsCableNameToFbsTag(List<FbsElement> fbsElements) Converts a FbsElement list into a map with entries (key, value - cable name, FBS tag).
static Map<String,FbsElement>	readMappingsEssNameToFbsElement(List<FbsElement> fbsElements) Converts a FbsElement list into a map with entries (key, value - ESS name, FbsElement).
static Map<String,String>	readMappingsEssNameToFbsTag(List<FbsElement> fbsElements) Converts a FbsElement list into a map with entries (key, value - ESS name, FBS tag).
static Map<String,String>	readMappingsFbsTagToEssName(List<FbsElement> fbsElements) Converts a FbsElement list into a map with entries (key, value - FBS tag, ESS name).
static Map<String,FbsElement>	readMappingsIdToFbsElement(List<FbsElement> fbsElements) Converts a FbsElement list into a map with entries (key, value - id, FbsElement).
static Map<String,FbsElement>	readMappingsTagToFbsElement(List<FbsElement> fbsElements) Converts a FbsElement list into a map with entries (key, value - tag, FbsElement).
static List<String>	readTags(List<FbsElement> fbsElements) Converts a FbsElement list into a list of FBS tags.

Methods inherited from class java.lang.Object

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

Method Detail

readMappingsCableNameToFbsTag

public static Map<String,String> readMappingsCableNameToFbsTag(List<FbsElement> fbsElements)

Converts a FbsElement list into a map with entries (key, value - cable name, FBS tag). A cable name can be associated with zero or one FBS tag.

Parameters:

fbsElements - FBS element list retrieved from server

Returns:

map of cable name-FBS tag pairs

readMappingsEssNameToFbsTag

public static Map<String,String> readMappingsEssNameToFbsTag(List<FbsElement> fbsElements)

Converts a FbsElement list into a map with entries (key, value - ESS name, FBS tag). An ESS name can be associated with zero or one FBS tag.

Parameters:

fbsElements - FBS element list retrieved from server

Returns:

map of ESS name-FBS tag pairs

readMappingsFbsTagToEssName

public static Map<String,String> readMappingsFbsTagToEssName(List<FbsElement> fbsElements)

Converts a FbsElement list into a map with entries (key, value - FBS tag, ESS name). An FBS tag can lack association with cable name and ESS name. An FBS tag can be associated with maximum one cable name and ESS name.

Parameters:

fbsElements - FBS element list retrieved from server

Returns:

map of FBS tag-ESS name pairs

readMappingsCableNameToFbsElement

public static Map<String,FbsElement> readMappingsCableNameToFbsElement(List<FbsElement> fbsElements)

Converts a FbsElement list into a map with entries (key, value - cable name, FbsElement).

Parameters:

fbsElements - FBS element list retrieved from server

Returns:

map of cable name - FbsElement pairs

readMappingsEssNameToFbsElement

public static Map<String,FbsElement> readMappingsEssNameToFbsElement(List<FbsElement> fbsElements)

Converts a FbsElement list into a map with entries (key, value - ESS name, FbsElement).

Parameters:

fbsElements - FBS element list retrieved from server

Returns:

map of ESS name - FbsElement pairs

readMappingsIdToFbsElement

public static Map<String,FbsElement> readMappingsIdToFbsElement(List<FbsElement> fbsElements)

Converts a FbsElement list into a map with entries (key, value - id, FbsElement).

Parameters:

fbsElements - FBS element list retrieved from server

Returns:

map of id - FbsElement pairs

readMappingsTagToFbsElement

public static Map<String,FbsElement> readMappingsTagToFbsElement(List<FbsElement> fbsElements)

Converts a FbsElement list into a map with entries (key, value - tag, FbsElement).

An FBS tag can lack association with cable name and ESS name. An FBS tag can be associated with maximum one cable name and ESS name.

Parameters:

fbsElements - FBS element list retrieved from server

Returns:

map of tag - FbsElement pairs

readTags

public static List<String> readTags(List<FbsElement> fbsElements)

Converts a FbsElement list into a list of FBS tags.

Parameters:

fbsElements - FBS element list retrieved from server

Returns:

list of FBS tags

getFbsElementForCableName

public static FbsElement getFbsElementForCableName(Collection<FbsElement> fbsElements,
                                                   String cableName)

Extract FbsElement that correspond to given cable name (exact match).

Parameters:

fbsElements - collection of FbsElement

cableName - given cable name to search for

Returns:

FbsElement that correspond to given cable name (exact match)

See Also:

FbsElement.cableName

getFbsElementsForCableName

public static List<FbsElement> getFbsElementsForCableName(Collection<FbsElement> fbsElements,
                                                          String cableName)

Extract list of FbsElement that correspond to given cable name (exact match). Expected length of list is 0 or 1.

Parameters:

fbsElements - collection of FbsElement

cableName - given cable name to search for

Returns:

list of FbsElement that correspond to given cable name (exact match)

See Also:

FbsElement.cableName

getFbsElementForEssName

public static FbsElement getFbsElementForEssName(Collection<FbsElement> fbsElements,
                                                 String essName)

Extract FbsElement that correspond to given ESS name (exact match).

Parameters:

fbsElements - collection of FbsElement

essName - given ESS name to search for

Returns:

FbsElement that correspond to given ESS name (exact match)

See Also:

FbsElement.essName

getFbsElementsForEssName

public static List<FbsElement> getFbsElementsForEssName(Collection<FbsElement> fbsElements,
                                                        String essName)

Extract list of FbsElement that correspond to given ESS name (exact match). Expected length of list is 0 or 1.

Parameters:

fbsElements - collection of FbsElement

essName - given ESS name to search for

Returns:

list of FbsElement that correspond to given ESS name (exact match)

See Also:

FbsElement.essName

getFbsElementForId

public static FbsElement getFbsElementForId(Collection<FbsElement> fbsElements,
                                            String id)

Extract FbsElement that correspond to given id (exact match).

Parameters:

fbsElements - collection of FbsElement

id - given id to search for

Returns:

FbsElement that correspond to given id (exact match)

See Also:

FbsElement.id

getFbsElementsForId

public static List<FbsElement> getFbsElementsForId(Collection<FbsElement> fbsElements,
                                                   String id)

Extract list of FbsElement that correspond to given id (exact match). Expected length of list is 0 or 1.

Parameters:

fbsElements - collection of FbsElement

id - given id to search for

Returns:

list of FbsElement that correspond to given id (exact match)

See Also:

FbsElement.id

getFbsElementForTag

public static FbsElement getFbsElementForTag(Collection<FbsElement> fbsElements,
                                             String tag)

Extract FbsElement that correspond to given tag (exact match).

Parameters:

fbsElements - collection of FbsElement

tag - given tag to search for

Returns:

FbsElement that correspond to given tag (exact match)

See Also:

FbsElement.tag

getFbsElementsForTag

public static List<FbsElement> getFbsElementsForTag(Collection<FbsElement> fbsElements,
                                                    String tag)

Extract list of FbsElement that correspond to given tag (exact match). Expected length of list is 0 or 1.

Parameters:

fbsElements - collection of FbsElement

tag - given tag to search for

Returns:

list of FbsElement that correspond to given tag (exact match)

See Also:

FbsElement.tag