gov.nih.nci.dtsrpc.client
Class AttributeSetDescriptor

java.lang.Object
  gov.nih.nci.dtsrpc.client.AttributeSetDescriptor

All Implemented Interfaces:

java.io.Serializable

public class AttributeSetDescriptor

extends java.lang.Object

implements java.io.Serializable

An AttributeSetDescriptor is a description of the set of Concept attributes that should be retrieved by a given operation.

A Concept attribute is either a NCIRole or a NCIProperty.

A typical use of an AttributeSetDescriptor by an application program would be to specify the set of Concept attributes to be retrieved for the application under various circumstances.

For example: One example would be to define an AttributeSetDescriptor instance PHARMACY_ORDER_ATTRIBUTES that would specify the set of attributes needed to populate the application's Pharmacy order page. Then PHARMACY_ORDER_ATTRIBUTES would be passed to any operation performed in support of the Pharmacy order page to ensure that the right set of attributes (e.g. the NDC_Number property, the DoseForm role, etc.) was retrieved.

Since:

DTSRPC 1.3.3

Version:

1.3.3

Author:

Northrop Grumman Mission Systems

See Also:

Serialized Form

Field Summary

static AttributeSetDescriptor	ALL_ATTRIBUTES ALL_ATTRIBUTES is a special AttributeSetDescriptor that will cause all attributes of a concept to be fetched.
static AttributeSetDescriptor	ALL_PROPERTIES ALL_PROPERTIES is a special AttributeSetDescriptor that will cause all properties of a concept to be fetched.
static AttributeSetDescriptor	ALL_ROLES ALL_ROLES is a special AttributeSetDescriptor that will cause all roles of a concept to be fetched.
static AttributeSetDescriptor	NO_ATTRIBUTES NO_ATTRIBUTES is a special AttributeSetDescriptor that will cause no attributes of a concept to be fetched.
static int	WITH_ALL_ATTRIBUTES A static constant, 1
static int	WITH_ALL_PROPERTIES A static constant, 3
static int	WITH_ALL_ROLES A static constant, 2
static int	WITH_NO_ATTRIBUTES A static constant, 0

Constructor Summary

AttributeSetDescriptor(java.lang.String name)
Constructs an AttributeSetDescriptor with the given name.

Method Summary

void	addProperty(java.lang.String name) Adds a property to the set of attributes that will be retrieved by any operation that uses this AttributeSetDescriptor.
void	addRole(java.lang.String name) Adds a role to the set of attributes that will be retrieved by any operation that uses this AttributeSetDescriptor.
java.lang.String	getName() Gets the name of the AttributeSetDescriptor.
java.util.Vector	getProperties() Gets names of properties that will be retrieved by any operation that uses this AttributeSetDescriptor.
java.util.Vector	getRoles() Gets the names of roles that will be retrieved by any operation that uses this AttributeSetDescriptor.
java.lang.String	toString() Gets the string representation of the AttributeSetDescriptor object

Methods inherited from class java.lang.Object

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

Field Detail

ALL_ATTRIBUTES

public static final AttributeSetDescriptor ALL_ATTRIBUTES

ALL_ATTRIBUTES is a special AttributeSetDescriptor that will cause all attributes of a concept to be fetched.

ALL_PROPERTIES

public static final AttributeSetDescriptor ALL_PROPERTIES

ALL_PROPERTIES is a special AttributeSetDescriptor that will cause all properties of a concept to be fetched.

ALL_ROLES

public static final AttributeSetDescriptor ALL_ROLES

ALL_ROLES is a special AttributeSetDescriptor that will cause all roles of a concept to be fetched.

NO_ATTRIBUTES

public static final AttributeSetDescriptor NO_ATTRIBUTES

NO_ATTRIBUTES is a special AttributeSetDescriptor that will cause no attributes of a concept to be fetched.

WITH_NO_ATTRIBUTES

public static final int WITH_NO_ATTRIBUTES

A static constant, 0

See Also:

Constant Field Values

WITH_ALL_ATTRIBUTES

public static final int WITH_ALL_ATTRIBUTES

A static constant, 1

See Also:

Constant Field Values

WITH_ALL_ROLES

public static final int WITH_ALL_ROLES

A static constant, 2

See Also:

Constant Field Values

WITH_ALL_PROPERTIES

public static final int WITH_ALL_PROPERTIES

A static constant, 3

See Also:

Constant Field Values

Constructor Detail

AttributeSetDescriptor

public AttributeSetDescriptor(java.lang.String name)

Constructs an AttributeSetDescriptor with the given name.

Parameters:

name - - name of the AttributeSetDescriptor.

Since:

DTSRPC 1.3.3

Method Detail

getName

public java.lang.String getName()

Gets the name of the AttributeSetDescriptor.

Returns:

the name of the AttributeSetDescriptor instance.

Since:

DTSRPC 1.3.3

addProperty

public void addProperty(java.lang.String name)

Adds a property to the set of attributes that will be retrieved by any operation that uses this AttributeSetDescriptor.

Parameters:

name - the property name which is added.

Since:

DTSRPC 1.3.3

addRole

public void addRole(java.lang.String name)

Adds a role to the set of attributes that will be retrieved by any operation that uses this AttributeSetDescriptor.

Parameters:

name - the role name which is added.

Since:

DTSRPC 1.3.3

getProperties

public java.util.Vector getProperties()

Gets names of properties that will be retrieved by any operation that uses this AttributeSetDescriptor.

Returns:

a vector of the set of properties.

Since:

DTSRPC 1.3.3

getRoles

public java.util.Vector getRoles()

Gets the names of roles that will be retrieved by any operation that uses this AttributeSetDescriptor.

Returns:

a vector of the set of roles.

Since:

DTSRPC 1.3.3

toString

public java.lang.String toString()

Gets the string representation of the AttributeSetDescriptor object

Returns:

a string representation of the object.

Since:

DTSRPC 1.3.3