com.esri.aims.mtier.model.metadata.publish
Class Publish

java.lang.Object
  com.esri.aims.mtier.model.metadata.publish.Publish

public class Publish
extends Object

Used to publish data to the Metadata Server.

Constructor Summary

Publish()

Method Summary

String	addMetadata(ConnectionProxy cp) Adds the dataset that is represented by the dataset instance field.
String	addMetadataRelationship(ConnectionProxy cp, String docId) Establishes a relationship between a source metadata document and one or more child or sibling metadata documents.
String	addMetadataSemantic(ConnectionProxy cp) Sets the framework for establishing a relationship between a tag and the numeric code defining semantics from the GEO Attribute Set.
boolean	addRelevance(int relevance, ConnectionProxy cp) Adds a relevance to the Dataset in the Metadata repository.
String	changeMetadataAccess(ConnectionProxy cp) Changes the access of a metadata document.
String	changeMetadataName(ConnectionProxy cp, String docId, String newName) Changes the name of a metadata document.
String	changeOwner(ConnectionProxy cp, String docId, String newOwner) Changes the owner of a metadata document.
String	deleteMetadata(ConnectionProxy cp) Deletes the dataset represented by the dataset instance field.
String	deleteMetadataRelationship(ConnectionProxy cp, String docId) Deletes relationships beween a source metadata document and one or more child/sibling metadata documents.
Dataset	getDataset() Returns the dataset object.
MetadataRelationshipCollection	getMetadataRelationshipCollection() Returns the MetadataRelationshipCollection associated with this object.
SemanticPairCollection	getSemanticPairCollection() Returns the SemanticPairCollection object associated with this object.
void	setDataset(Dataset dataset) Sets the given dataset.
void	setMetadataRelationshipCollection(MetadataRelationshipCollection newMetadataRelationshipColl) Sets the given MetadataRelationshipCollection with this object.
void	setSemanticPairCollection(SemanticPairCollection newSemanticPairColl) Sets the SemanticPairCollection for this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Publish

public Publish()

Method Detail

addMetadata

public String addMetadata(ConnectionProxy cp)
                   throws ConnectionParameterException,
                          com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                          AuthenticationException,
                          IOException

Adds the dataset that is represented by the dataset instance field.

Parameters:

cp - The ConnnectionProxy that is used to connect to the ArcIMS Server.

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

deleteMetadata

public String deleteMetadata(ConnectionProxy cp)
                      throws ConnectionParameterException,
                             com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                             AuthenticationException,
                             IOException

Deletes the dataset represented by the dataset instance field.

Parameters:

cp - the ConnnectionProxy used to connect to the ArcIMS Server.

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

addMetadataRelationship

public String addMetadataRelationship(ConnectionProxy cp,
                                      String docId)
                               throws ConnectionParameterException,
                                      com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                      AuthenticationException,
                                      IOException

Establishes a relationship between a source metadata document and one or more child or sibling metadata documents.

Parameters:

cp - the ConnnectionProxy used to connect to the ArcIMS Server.

docId - identifies the source or parent metadata document.

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

deleteMetadataRelationship

public String deleteMetadataRelationship(ConnectionProxy cp,
                                         String docId)
                                  throws ConnectionParameterException,
                                         com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                         AuthenticationException,
                                         IOException

Deletes relationships beween a source metadata document and one or more child/sibling metadata documents.

Parameters:

cp - the ConnnectionProxy used to connect to the ArcIMS Server.

docId - identifies the source or parent metadata document.

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

addMetadataSemantic

public String addMetadataSemantic(ConnectionProxy cp)
                           throws ConnectionParameterException,
                                  com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                  AuthenticationException,
                                  IOException

Sets the framework for establishing a relationship between a tag and the numeric code defining semantics from the GEO Attribute Set.

Parameters:

cp - the ConnnectionProxy that is used to connect to the ArcIMS Server.

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

changeMetadataAccess

public String changeMetadataAccess(ConnectionProxy cp)
                            throws ConnectionParameterException,
                                   com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                   AuthenticationException,
                                   IOException

Changes the access of a metadata document.

Parameters:

cp - the ConnnectionProxy used to connect to the ArcIMS Server.

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

changeOwner

public String changeOwner(ConnectionProxy cp,
                          String docId,
                          String newOwner)
                   throws ConnectionParameterException,
                          com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                          AuthenticationException,
                          IOException

Changes the owner of a metadata document.

Parameters:

cp - the ConnnectionProxy used to connect to the ArcIMS Server.

docId - The document ID. (REQUIRED)

newOwner - New owner for the given metadata. (REQUIRED)

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

changeMetadataName

public String changeMetadataName(ConnectionProxy cp,
                                 String docId,
                                 String newName)
                          throws ConnectionParameterException,
                                 com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                 AuthenticationException,
                                 IOException

Changes the name of a metadata document.

Parameters:

cp - the ConnnectionProxy used to connect to the ArcIMS Server.

docId - The document ID. (REQUIRED)

newName - New name for the given metadata. (REQUIRED)

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

addRelevance

public boolean addRelevance(int relevance,
                            ConnectionProxy cp)
                     throws ConnectionParameterException,
                            com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                            AuthenticationException,
                            IOException

Adds a relevance to the Dataset in the Metadata repository.

Parameters:

relevance - the new relevance rating to give to the Dataset. This value must be between 1 and 10.

cp - The ConnnectionProxy to use to make the request to the server.

Throws:

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

IOException

setDataset

public void setDataset(Dataset dataset)

Sets the given dataset.

getDataset

public Dataset getDataset()

Returns the dataset object.

setMetadataRelationshipCollection

public void setMetadataRelationshipCollection(MetadataRelationshipCollection newMetadataRelationshipColl)

Sets the given MetadataRelationshipCollection with this object.

getMetadataRelationshipCollection

public MetadataRelationshipCollection getMetadataRelationshipCollection()

Returns the MetadataRelationshipCollection associated with this object.

setSemanticPairCollection

public void setSemanticPairCollection(SemanticPairCollection newSemanticPairColl)

Sets the SemanticPairCollection for this object.

getSemanticPairCollection

public SemanticPairCollection getSemanticPairCollection()

Returns the SemanticPairCollection object associated with this object.