jpl.eda.metadata.registry.schema
Class SchemaClient

java.lang.Object
  jpl.eda.metadata.registry.schema.SchemaClient

public class SchemaClient

extends java.lang.Object

This class serves as the application program interface (API) to the Schema Registry Service.

Author:

Cynthia Wong

Constructor Summary

SchemaClient()
Constructor given nothing.

SchemaClient(java.lang.String registryServiceName)
Constructor given an Schema name.

Method Summary

java.lang.String	add(java.util.Map attrMap, java.lang.String fullFileName) Add a schema to the metadata repository given its attributes and location.
java.lang.String	add(java.lang.String attrFileName, java.lang.String fullFileName) Add a schema to the metadata repository given its attributes and location.
java.lang.String	create(java.util.Map dcAttribute) Create a empty schema (collection) holder.
java.lang.String	create(java.lang.String fileName) Create an empty schema
java.util.Vector	get(java.lang.String registryId, java.lang.String schemaId) Get description of a registered schema
org.w3c.dom.Document	getProfileDocument(java.util.List profileList)
java.util.List	getProfiles(java.util.List schemaList) Get a list profiles using a list schemata
java.lang.String	getProfileString(java.util.List profileList)
void	getSchemaObject() Get authorized schema object.
java.lang.String	getValidMsg()
java.util.List	keywordSearch(java.util.Map attributes) Search schema with given set of keywords
java.util.List	list() Get a list of all registered schemas
AuthorizedRegistry	login()
static void	main(java.lang.String[] argv)
java.lang.String	modify(java.util.Map metadata)
java.lang.String	modify(java.lang.String schemaId, java.lang.String version, java.lang.String registryId, java.util.Map inMetadata)
java.util.List	query(java.lang.String kwdString) Query element using DIS-Style query string;
java.util.List	query(jpl.eda.xmlquery.XMLQuery xmlQuery) Query schema using DIS-Style query string
java.lang.String	release(java.lang.String registryId)
java.lang.String	release(java.lang.String id, java.lang.String version)
java.lang.String	remove(java.lang.String registryId)
java.lang.String	remove(java.lang.String id, java.lang.String version)
java.lang.String	removeAll(java.lang.String id)
void	setCredential(java.lang.String username, java.lang.String password) Set username and password, login the new user and get dictionary object.
java.util.List	textSearch(java.lang.String queryString) Search schema with given a text query string
boolean	validate(java.io.File xmlFile)
boolean	validate(java.lang.String xmlFilename)
java.util.List	xmlQuery(java.lang.String kwdString) Query element using DIS-Style query string; Returns a list of profiles;
java.util.List	xmlQuery(jpl.eda.xmlquery.XMLQuery xmlQuery) Query element using DIS-Style query string; Returns a list of profiles;

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaClient

public SchemaClient()

Constructor given nothing. This constructor does nothing.

SchemaClient

public SchemaClient(java.lang.String registryServiceName)
             throws ClientException

Constructor given an Schema name. This constructor finds the Schema object from the naming service and makes it available for the client's use.

Parameters:

registryServiceName - The Metadata Registry Server's name

Throws:

ClientException - If the object found was not the Schema Service.

Method Detail

login

public AuthorizedRegistry login()
                         throws ClientException

Throws:

ClientException

getSchemaObject

public void getSchemaObject()
                     throws ClientException

Get authorized schema object.

Returns:

The authorized schema object

Throws:

ClientException

setCredential

public void setCredential(java.lang.String username,
                          java.lang.String password)
                   throws ClientException

Set username and password, login the new user and get dictionary object.

Parameters:

username - The user name.

password - The user's password

Throws:

ClientException

create

public java.lang.String create(java.lang.String fileName)
                        throws ClientException

Create an empty schema

Parameters:

fileName - filename of file that containing the metadata for schema

Returns:

The registry identifier of schema

Throws:

ClientException

create

public java.lang.String create(java.util.Map dcAttribute)
                        throws ClientException

Create a empty schema (collection) holder.

Parameters:

dcAttribute - Dublin Core Attributes to describe collection.

Returns:

The registry identifier of schema

Throws:

ClientException

add

public java.lang.String add(java.util.Map attrMap,
                            java.lang.String fullFileName)
                     throws ClientException

Add a schema to the metadata repository given its attributes and location.

Parameters:

attrMap - Attribute list in java Map class

fullFileName - Full path of file name for the schema

Returns:

The registry identifier of schema

Throws:

ClientException

add

public java.lang.String add(java.lang.String attrFileName,
                            java.lang.String fullFileName)
                     throws ClientException

Add a schema to the metadata repository given its attributes and location.

Parameters:

attrFileName - Full path of file name for the attributes

fullFileName - Full path of file name for the schema

Returns:

The registry identifier of schema

Throws:

ClientException

list

public java.util.List list()
                    throws ClientException

Get a list of all registered schemas

Returns:

A list of all registered schemas;

Throws:

ClientException

textSearch

public java.util.List textSearch(java.lang.String queryString)
                          throws ClientException

Search schema with given a text query string

Parameters:

queryString - a text query string

Returns:

A list of registered schemas

Throws:

ClientException

keywordSearch

public java.util.List keywordSearch(java.util.Map attributes)
                             throws ClientException

Search schema with given set of keywords

Parameters:

attributes - The specified set of attributes

Returns:

A list of registered schemas

Throws:

ClientException

query

public java.util.List query(jpl.eda.xmlquery.XMLQuery xmlQuery)
                     throws ClientException

Query schema using DIS-Style query string

Throws:

ClientException

query

public java.util.List query(java.lang.String kwdString)
                     throws ClientException

Query element using DIS-Style query string;

Throws:

ClientException

getProfiles

public java.util.List getProfiles(java.util.List schemaList)
                           throws ClientException

Get a list profiles using a list schemata

Throws:

ClientException

xmlQuery

public java.util.List xmlQuery(jpl.eda.xmlquery.XMLQuery xmlQuery)
                        throws ClientException

Query element using DIS-Style query string; Returns a list of profiles;

Throws:

ClientException

xmlQuery

public java.util.List xmlQuery(java.lang.String kwdString)
                        throws ClientException

Query element using DIS-Style query string; Returns a list of profiles;

Throws:

ClientException

getProfileDocument

public org.w3c.dom.Document getProfileDocument(java.util.List profileList)

getProfileString

public java.lang.String getProfileString(java.util.List profileList)

get

public java.util.Vector get(java.lang.String registryId,
                            java.lang.String schemaId)
                     throws ClientException

Get description of a registered schema

Parameters:

registryId - Schema registration identifier

schemaId - Schema identifier

Returns:

schema & its element list

Throws:

ClientException

validate

public boolean validate(java.lang.String xmlFilename)

validate

public boolean validate(java.io.File xmlFile)

getValidMsg

public java.lang.String getValidMsg()

modify

public java.lang.String modify(java.lang.String schemaId,
                               java.lang.String version,
                               java.lang.String registryId,
                               java.util.Map inMetadata)
                        throws ClientException

Throws:

ClientException

modify

public java.lang.String modify(java.util.Map metadata)
                        throws ClientException

Throws:

ClientException

remove

public java.lang.String remove(java.lang.String registryId)
                        throws ClientException

Throws:

ClientException

remove

public java.lang.String remove(java.lang.String id,
                               java.lang.String version)
                        throws ClientException

Throws:

ClientException

removeAll

public java.lang.String removeAll(java.lang.String id)
                           throws ClientException

Throws:

ClientException

release

public java.lang.String release(java.lang.String registryId)
                         throws ClientException

Throws:

ClientException

release

public java.lang.String release(java.lang.String id,
                                java.lang.String version)
                         throws ClientException

Throws:

ClientException

main

public static void main(java.lang.String[] argv)
                 throws java.lang.Exception

Throws:

java.lang.Exception