org.codice.ddf.registry.common.metacard

Class RegistryUtility

java.lang.Object

org.codice.ddf.registry.common.metacard.RegistryUtility

public class RegistryUtility
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	REGISTRY_ID_REGEX

Constructor Summary

Constructors

Constructor and Description
RegistryUtility()

Method Summary

Modifier and Type	Method and Description
static boolean	getBooleanAttribute(Metacard metacard, String attributeToCheck) Identifies whether the metacard has the attribute and its boolean value
static List<String>	getListOfStringAttribute(Metacard metacard, String attributeToCheck) Attempts to return a List of Strings from an attribute.
static String	getRegistryId(Metacard metacard) Returns the registry id of the metacard passed in.
static String	getStringAttribute(Metacard metacard, String attributeToCheck, String defaultValue) Attempts to return a String attribute's value.
static boolean	hasAttribute(Metacard metacard, String attributeName) Simple method to just check for the existance of an attribute on a metacard
static boolean	isIdentityNode(Metacard metacard) Identifies whether the metacard is a registry identity node
static boolean	isInternalRegistryMetacard(Metacard metacard) Checks that the metacard passed in has the internal Registry metacard tag and a valid RegistryId.
static boolean	isLocalNode(Metacard metacard) Identifies whether the metacard is a local registry node
static boolean	isRegistryMetacard(Metacard metacard) Checks that the metacard passed in has the Registry metacard tag and a valid RegistryId.
static boolean	validRegistryId(String registryId) Checks if the given registryId is of a valid format.

Methods inherited from class java.lang.Object

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

Field Detail

REGISTRY_ID_REGEX

public static final String REGISTRY_ID_REGEX

See Also:

Constant Field Values

Constructor Detail

RegistryUtility

public RegistryUtility()

Method Detail

validRegistryId

public static boolean validRegistryId(String registryId)

Checks if the given registryId is of a valid format.

Parameters:

registryId - registryId to be checked

Returns:

true if registryId matches the expected format, false otherwise.

isRegistryMetacard

public static boolean isRegistryMetacard(Metacard metacard)

Checks that the metacard passed in has the Registry metacard tag and a valid RegistryId.

Parameters:

metacard - - will have tags and RegistryId evaluated

Returns:

true if registryId is present in the metacard with the Registry_Tag, false otherwise

isInternalRegistryMetacard

public static boolean isInternalRegistryMetacard(Metacard metacard)

Checks that the metacard passed in has the internal Registry metacard tag and a valid RegistryId.

Parameters:

metacard - - will have tags and RegistryId evaluated

Returns:

true if registryId is present in the metacard with the Registry_Tag_Internal, false otherwise

getRegistryId

public static String getRegistryId(Metacard metacard)

Returns the registry id of the metacard passed in. In most cases this method expects that the user has already evaluated the metacard with the isRegistryMetacard method from this class.

Parameters:

metacard - - the metacard for which the registry Id will be returned

Returns:

the String representation of the metacard's registry id attribute, null if not present

isIdentityNode

public static boolean isIdentityNode(Metacard metacard)

Identifies whether the metacard is a registry identity node

Parameters:

metacard - - metacard to be evaluated for registry identity status

Returns:

true if the metacard is an identity node, false otherwise

isLocalNode

public static boolean isLocalNode(Metacard metacard)

Identifies whether the metacard is a local registry node

Parameters:

metacard - - metacard to be evaluated for local registry status

Returns:

true if the metacard is an local node, false otherwise

getBooleanAttribute

public static boolean getBooleanAttribute(Metacard metacard,
                                          String attributeToCheck)

Identifies whether the metacard has the attribute and its boolean value

Parameters:

metacard - - metacard to be evaluated for boolean attribute

attributeToCheck - - attribute to be evaluted, expected to be boolean in value

Returns:

true if the attribute is present and set to true, false if the attribute is not present set to null, or not a boolean valued attribute

getStringAttribute

public static String getStringAttribute(Metacard metacard,
                                        String attributeToCheck,
                                        String defaultValue)

Attempts to return a String attribute's value. If the attribute is null the default value will be returned instead.

Parameters:

metacard - - metacard to be evaluated for a String type attribute

attributeToCheck - - attribute to be checked for, should have a String type

defaultValue - - the value expected to be returned if the attribute is not present

Returns:

the defaultValue if attribute is not present, otherwise a String representing the value of the attribute

getListOfStringAttribute

public static List<String> getListOfStringAttribute(Metacard metacard,
                                                    String attributeToCheck)

Attempts to return a List of Strings from an attribute. If the attribute is null the default value will be returned instead.

Parameters:

metacard - - metacard to be evaluated for a List of Strings type attribute

attributeToCheck - - attribute to be checked for, should be a List of Strings type

Returns:

the defaultValue if attribute is not present, otherwise a List of Strings representing the values of the attribute

hasAttribute

public static boolean hasAttribute(Metacard metacard,
                                   String attributeName)

Simple method to just check for the existance of an attribute on a metacard

Parameters:

metacard - - metacard to check for attribute on

attributeName - - name of attribute to check

Returns: