Package cern.dip
Interface DipBrowser
-
- All Known Implementing Classes:
DipBrowserImp
,MockDipBrowser
public interface DipBrowser
Interface allowing a user to browse the DIP namespace.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String[]
getPublications(java.lang.String pattern)
Obtain a list of all publications visable in the DIP namespace.int
getSize()
Get the cardinality of the default field (where a primitive type is being sent).int
getSize(java.lang.String tag)
Get the cardinality of the field who's name is supplied as a parameter.java.lang.String[]
getTags(java.lang.String pub)
Get the fields names within the publication having the supplied publication name.int
getType()
Get the type of the default field (where a primitive type is being sent).int
getType(java.lang.String tag)
Get the type of the field who's name is supplied as a parameter.
-
-
-
Method Detail
-
getPublications
java.lang.String[] getPublications(java.lang.String pattern)
Obtain a list of all publications visable in the DIP namespace. If no publications are visable an empty array is returned.- Parameters:
pattern
- wildcard string. * @return array of publication names.
-
getTags
java.lang.String[] getTags(java.lang.String pub) throws DipException
Get the fields names within the publication having the supplied publication name. Should always be at least one field. A primitive type will return the tag name __DIP_DEFAULT__- Parameters:
pub
- name of the publication we want the fields of.- Returns:
- Array of fields within the publication.
- Throws:
DipException
- if the format discription of the publication is incorrect
-
getType
int getType() throws DipException
Get the type of the default field (where a primitive type is being sent). Must be called after first calling getTags() for the publication of interest.- Returns:
- type of the primitive sent in the DipData object as defined in the DipData class
- Throws:
DipException
- if getTags() has not been previous called or the object does not hold a primitive type- See Also:
DipData
-
getSize
int getSize() throws DipException
Get the cardinality of the default field (where a primitive type is being sent). Must be called after first calling getTags() for the publication of interest. Note that a non array type will return the value 1.- Returns:
- cardinality of the primitive sent in the DipData object.
- Throws:
DipException
- if getTags() has not been previous called or the object does not hold a primitive type- See Also:
DipData
-
getType
int getType(java.lang.String tag) throws DipException
Get the type of the field who's name is supplied as a parameter. Must be called after first calling getTags() for the publication of interest.- Parameters:
name
- of the field whos type we are interested in.- Returns:
- type of the field sent in the DipData object as defined in the DipData class
- Throws:
DipException
- if getTags() has not been previous called or the object does not hold a complex type- See Also:
getTags()
,DipData
-
getSize
int getSize(java.lang.String tag) throws DipException
Get the cardinality of the field who's name is supplied as a parameter. Must be called after first calling getTags() for the publication of interest. Note that a non array type will return the value 1.- Parameters:
name
- of the field whos cardinality we are interested in.- Returns:
- cardinality of the field sent in the DipData object as defined in the DipData class
- Throws:
DipException
- if getTags() has not been previous called or the object does not hold a complex type- See Also:
DipData
-
-