Package thredds.catalog

Class InvDatasetImplProxy

java.lang.Object

thredds.catalog.InvDataset

thredds.catalog.InvDatasetImpl

thredds.catalog.InvDatasetImplProxy

public class InvDatasetImplProxy
extends InvDatasetImpl

Proxy an InvDatasetImpl to another InvDatasetImpl.

Field Summary

Fields inherited from class thredds.catalog.InvDatasetImpl

log, mark, ncmlElement, tm, tmi

Fields inherited from class thredds.catalog.InvDataset

access, authorityName, catalog, collectionType, contributors, creators, dataFormatType, datasets, dataType, dates, defaultService, docs, gc, harvest, id, keywords, metadata, name, parent, projects, properties, publishers, restrictAccess, services, tc, variableMapLink, variables

Constructor Summary

Constructors

Constructor	Description
InvDatasetImplProxy(String aliasName, InvDatasetImpl proxy)

Method Summary

Modifier and Type	Method	Description
void	addAccess(InvAccess p0)	Add InvAccess element to this dataset.
void	addDataset(InvDatasetImpl p0)	Add a nested dataset.
void	addDocumentation(InvDocumentation p0)	Add documentation element to this dataset.
void	addProperty(InvProperty p0)	Add a property to this dataset
void	addService(InvService p0)	Add a service to this dataset.
String	dump()
boolean	equals(Object p0)	InvDatasetImpl elements with same values are equal.
InvDatasetImpl	findDatasetByName(String p0)	Find an immediate child dataset by its name.
String	findProperty(String p0)	Finds the first property declared in the dataset with the given name.
InvService	findService(String p0)	Find the named service declared in this dataset or one of its parents.
boolean	finish()	Finish constructing after all elements have been added.
List<InvAccess>	getAccess()	Get all access elements for this dataset.
InvAccess	getAccess(ServiceType p0)	Get access element of the specified service type for this dataset.
List<InvAccess>	getAccessLocal()
String	getAlias()
String	getAliasName()
String	getAuthority()	Get authority for this Dataset, may be null.
CalendarDateRange	getCalendarDateCoverage()	get time coverage as CalendarDateRange
CollectionType	getCollectionType()	Get collectionType
List<ThreddsMetadata.Contributor>	getContributors()	get Contributor metadata
List<ThreddsMetadata.Source>	getCreators()	get any Creator metadata
DataFormatType	getDataFormatType()	Get the DataFormatType (which may be inherited from parent), or null .
List<InvDataset>	getDatasets()	Get a list of all the nested datasets.
FeatureType	getDataType()	Get the DataType (which may be inherited from parent), or null .
List<DateType>	getDates()	get any DateType metadata
List<InvDocumentation>	getDocumentation()	Get list of documentation elements for this dataset.
String	getDocumentation(String p0)	get specific type of documentation
String	getFullName()	Get the full, heirarchical name of the dataset, which has all parent collection names.
ThreddsMetadata.GeospatialCoverage	getGeospatialCoverage()	get geospatial coverage
String	getID()	Get the id of the dataset, or null.
List<ThreddsMetadata.Vocab>	getKeywords()	get any Keyword metadata
ThreddsMetadata	getLocalMetadata()	Get the metadata stored in this dataset element.
protected boolean	getMark()	Filtering
List<InvMetadata>	getMetadata()	Get the metadata elements for this InvDataset.
List<InvMetadata>	getMetadata(MetadataType p0)	Get the metadata elements of the specified type.
String	getName()	Get the "human readable" name of the dataset.
InvDataset	getParent()	Get parent dataset.
InvCatalog	getParentCatalog()	Get containing catalog.
List<ThreddsMetadata.Vocab>	getProjects()	get Projects metadata
List<InvProperty>	getProperties()	Get all properties for this dataset.
List<ThreddsMetadata.Source>	getPublishers()	get Publisher metadata
InvService	getServiceDefault()	Find the default service for this dataset and its children.
List<InvService>	getServicesLocal()	Get services attached specifically to this dataset.
String	getUniqueID()	If this dataset has an authority and an ID, then the concatenation of them is the globally unique ID.
String	getUrlPath()	Get urlPath for this Dataset
Object	getUserProperty(Object p0)	Look up the User property having the given key
List<ThreddsMetadata.Variables>	getVariables()	get Variable metadata
boolean	hasAccess()	If this dataset has access elements.
int	hashCode()	Override Object.hashCode() to implement equals.
boolean	hasNestedDatasets()	If this dataset has nested datasets.
boolean	isHarvest()
boolean	removeDataset(InvDatasetImpl p0)	Remove the given dataset element from this dataset if it is in the dataset.
void	removeService(InvService p0)	Remove a service from this dataset.
void	setAlias(String p0)	Set alias for this Dataset
void	setAuthority(String p0)	Set authorityName for this Dataset
void	setCatalog(InvCatalog p0)	Set the containing catalog; use only for top level dataset.
void	setCollectionType(CollectionType p0)	Set collectionType
void	setContributors(List<ThreddsMetadata.Contributor> p0)
void	setGeospatialCoverage(ThreddsMetadata.GeospatialCoverage p0)
void	setHarvest(boolean p0)	Set harvest
void	setID(String p0)	Set the ID for this Dataset
void	setKeywords(List<ThreddsMetadata.Vocab> p0)
void	setLocalMetadata(ThreddsMetadata p0)
protected void	setMark(boolean p0)
void	setName(String p0)	Set name of this Dataset.
void	setParent(InvDatasetImpl p0)	Set the parent dataset.
void	setProjects(List<ThreddsMetadata.Vocab> p0)
void	setPublishers(List<ThreddsMetadata.Source> p0)
void	setServicesLocal(List<InvService> p0)	Set the list of services attached specifically to this dataset.
void	setTimeCoverage(DateRange p0)
void	setUrlPath(String p0)	Set the urlPath for this InvDatasetImpl
void	setUserProperty(Object p0, Object p1)
String	toString()

Methods inherited from class thredds.catalog.InvDatasetImpl

addAccess, addDataset, canonicalize, getDataSize, getLastModifiedDate, getLocalMetadataInheritable, getNcmlElement, getParentReal, getServiceName, removeLocalMetadata, replaceDataset, resolve, setDataFormatType, setDataSize, setDataType, setLastModifiedDate, setLastModifiedDate, setNcmlElement, setResourceControl, setServiceName, setTimeCoverage, transferMetadata, writeHtmlDescription, writeHtmlDescription

Methods inherited from class thredds.catalog.InvDataset

findAccess, getCatalogUrl, getHistory, getProcessing, getRestrictAccess, getRights, getSubsetUrl, getSummary, getTimeCoverage, getVariableMapLink, getVariables

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvDatasetImplProxy

public InvDatasetImplProxy(String aliasName,
                           InvDatasetImpl proxy)

Method Detail

getAliasName

public String getAliasName()

addAccess

public void addAccess(InvAccess p0)

Description copied from class: InvDatasetImpl

Add InvAccess element to this dataset.

Overrides:

addAccess in class InvDatasetImpl

Parameters:

p0 - add dthis

addDataset

public void addDataset(InvDatasetImpl p0)

Description copied from class: InvDatasetImpl

Add a nested dataset.

Overrides:

addDataset in class InvDatasetImpl

Parameters:

p0 - add this

addDocumentation

public void addDocumentation(InvDocumentation p0)

Description copied from class: InvDatasetImpl

Add documentation element to this dataset.

Overrides:

addDocumentation in class InvDatasetImpl

Parameters:

p0 - add this

addProperty

public void addProperty(InvProperty p0)

Description copied from class: InvDatasetImpl

Add a property to this dataset

Overrides:

addProperty in class InvDatasetImpl

Parameters:

p0 - add this

addService

public void addService(InvService p0)

Description copied from class: InvDatasetImpl

Add a service to this dataset.

Overrides:

addService in class InvDatasetImpl

Parameters:

p0 - add this service to the dataset

dump

public String dump()

Overrides:

dump in class InvDatasetImpl

Returns:

debugging info

equals

public boolean equals(Object p0)

Description copied from class: InvDatasetImpl

InvDatasetImpl elements with same values are equal.

Overrides:

equals in class InvDatasetImpl

findDatasetByName

public InvDatasetImpl findDatasetByName(String p0)

Description copied from class: InvDataset

Find an immediate child dataset by its name.

Overrides:

findDatasetByName in class InvDataset

Parameters:

p0 - match on this name

Returns:

dataset if found or null if not exist.

findProperty

public String findProperty(String p0)

Description copied from class: InvDataset

Finds the first property declared in the dataset with the given name. If a property other than the first is desired, it can be obtained via InvDataset.getProperties().

The property may have been specified in the dataset or in an enclosing parent element.

Overrides:

findProperty in class InvDataset

Parameters:

p0 - the name of the property.

Returns:

the string value of the first property with the given name or null if no such property exists.

findService

public InvService findService(String p0)

Description copied from class: InvDataset

Find the named service declared in this dataset or one of its parents.

Overrides:

findService in class InvDataset

Parameters:

p0 - match this name

Returns:

first service that matches the given name, or null if none found.

finish

public boolean finish()

Description copied from class: InvDatasetImpl

Finish constructing after all elements have been added. This does the inheritence thing This can be called again if new elements are added.

Overrides:

finish in class InvDatasetImpl

Returns:

true if successful.

getAccess

public InvAccess getAccess(ServiceType p0)

Description copied from class: InvDataset

Get access element of the specified service type for this dataset. If more than one, get the first one.

Overrides:

getAccess in class InvDataset

Parameters:

p0 - find this ServiceType

Returns:

InvAccess or null if there is not one.

getAccess

public List<InvAccess> getAccess()

Description copied from class: InvDataset

Get all access elements for this dataset. This list will expand any compound services.

Overrides:

getAccess in class InvDataset

Returns:

List of InvAccess objects. List may not be null, may be empty.

getAccessLocal

public List<InvAccess> getAccessLocal()

Overrides:

getAccessLocal in class InvDatasetImpl

Returns:

the local access (non-expanded) elements.

getAlias

public String getAlias()

Overrides:

getAlias in class InvDatasetImpl

Returns:

alias for this Dataset, if there is one

getAuthority

public String getAuthority()

Description copied from class: InvDataset

Get authority for this Dataset, may be null.

Overrides:

getAuthority in class InvDataset

Returns:

authority for this Dataset, or null.

getCollectionType

public CollectionType getCollectionType()

Description copied from class: InvDataset

Get collectionType

Overrides:

getCollectionType in class InvDataset

Returns:

collectionType, or null

getContributors

public List<ThreddsMetadata.Contributor> getContributors()

Description copied from class: InvDataset

get Contributor metadata

Overrides:

getContributors in class InvDataset

Returns:

List of type ThreddsMetadata.Contributor, may be empty

getCreators

public List<ThreddsMetadata.Source> getCreators()

Description copied from class: InvDataset

get any Creator metadata

Overrides:

getCreators in class InvDataset

Returns:

List of type ThreddsMetadata.Source, may be empty

getDataFormatType

public DataFormatType getDataFormatType()

Description copied from class: InvDataset

Get the DataFormatType (which may be inherited from parent), or null .

Overrides:

getDataFormatType in class InvDataset

Returns:

the DataFormatType or null .

getDataType

public FeatureType getDataType()

Description copied from class: InvDataset

Get the DataType (which may be inherited from parent), or null .

Overrides:

getDataType in class InvDataset

Returns:

the DataType or null

getDatasets

public List<InvDataset> getDatasets()

Description copied from class: InvDataset

Get a list of all the nested datasets.

Overrides:

getDatasets in class InvDataset

Returns:

list of objects of type InvDataset. May be empty, not null.

getDates

public List<DateType> getDates()

Description copied from class: InvDataset

get any DateType metadata

Overrides:

getDates in class InvDataset

Returns:

List of type DateType, may be empty

getDocumentation

public List<InvDocumentation> getDocumentation()

Description copied from class: InvDataset

Get list of documentation elements for this dataset.

Overrides:

getDocumentation in class InvDataset

Returns:

list of InvDocumentation objects. May be empty, not null.

getDocumentation

public String getDocumentation(String p0)

Description copied from class: InvDataset

get specific type of documentation

Overrides:

getDocumentation in class InvDataset

Parameters:

p0 - find this type of documentation

Returns:

contents of documentation of specified type

getFullName

public String getFullName()

Description copied from class: InvDataset

Get the full, heirarchical name of the dataset, which has all parent collection names.

Overrides:

getFullName in class InvDataset

Returns:

full, heirarchical name of the dataset, which has all parent collection names.

getGeospatialCoverage

public ThreddsMetadata.GeospatialCoverage getGeospatialCoverage()

Description copied from class: InvDataset

get geospatial coverage

Overrides:

getGeospatialCoverage in class InvDataset

Returns:

geospatial coverage, or null if none

getID

public String getID()

Description copied from class: InvDataset

Get the id of the dataset, or null.

Overrides:

getID in class InvDataset

Returns:

the id of the dataset, or null if none.

getKeywords

public List<ThreddsMetadata.Vocab> getKeywords()

Description copied from class: InvDataset

get any Keyword metadata

Overrides:

getKeywords in class InvDataset

Returns:

List of type ThreddsMetadata.Vocab, may be empty

getLocalMetadata

public ThreddsMetadata getLocalMetadata()

Description copied from class: InvDatasetImpl

Get the metadata stored in this dataset element. Inherited metadata only in an InvMetadata object.

Overrides:

getLocalMetadata in class InvDatasetImpl

Returns:

the metadata stored in this dataset element.

getMark

protected boolean getMark()

Description copied from class: InvDatasetImpl

Filtering

Overrides:

getMark in class InvDatasetImpl

Returns:

true if this is "marked"

getMetadata

public List<InvMetadata> getMetadata(MetadataType p0)

Description copied from class: InvDataset

Get the metadata elements of the specified type.

Overrides:

getMetadata in class InvDataset

Parameters:

p0 - find this metadata type

Returns:

List of InvMetadata objects. List may be empty but not null.

getMetadata

public List<InvMetadata> getMetadata()

Description copied from class: InvDataset

Get the metadata elements for this InvDataset.

Overrides:

getMetadata in class InvDataset

Returns:

List of InvMetadata objects. List may be empty but not null.

getName

public String getName()

Description copied from class: InvDataset

Get the "human readable" name of the dataset.

Overrides:

getName in class InvDataset

Returns:

"human readable" name of the dataset.

getParent

public InvDataset getParent()

Description copied from class: InvDataset

Get parent dataset.

Overrides:

getParent in class InvDataset

Returns:

parent dataset. If top dataset, return null.

getParentCatalog

public InvCatalog getParentCatalog()

Description copied from class: InvDataset

Get containing catalog.

Overrides:

getParentCatalog in class InvDataset

Returns:

containing catalog.

getProjects

public List<ThreddsMetadata.Vocab> getProjects()

Description copied from class: InvDataset

get Projects metadata

Overrides:

getProjects in class InvDataset

Returns:

List of type ThreddsMetadata.Vocab, may be empty

getProperties

public List<InvProperty> getProperties()

Description copied from class: InvDataset

Get all properties for this dataset. These may have been specified in the dataset or an enclosing parent element.

Overrides:

getProperties in class InvDataset

Returns:

List of type InvProperty. May be empty, not null.

getPublishers

public List<ThreddsMetadata.Source> getPublishers()

Description copied from class: InvDataset

get Publisher metadata

Overrides:

getPublishers in class InvDataset

Returns:

List of type ThreddsMetadata.Source, may be empty

getServiceDefault

public InvService getServiceDefault()

Description copied from class: InvDataset

Find the default service for this dataset and its children. If not declared in this dataset, search in parents. This is the default for any nested datasets or access elements.

Overrides:

getServiceDefault in class InvDataset

Returns:

default service, or null

getServicesLocal

public List<InvService> getServicesLocal()

Description copied from class: InvDatasetImpl

Get services attached specifically to this dataset.

Overrides:

getServicesLocal in class InvDatasetImpl

Returns:

List of type InvService. May be empty, but not null.

getCalendarDateCoverage

public CalendarDateRange getCalendarDateCoverage()

Description copied from class: InvDataset

get time coverage as CalendarDateRange

Overrides:

getCalendarDateCoverage in class InvDataset

Returns:

time coverage, or null if none

getUniqueID

public String getUniqueID()

Description copied from class: InvDataset

If this dataset has an authority and an ID, then the concatenation of them is the globally unique ID.

Overrides:

getUniqueID in class InvDataset

Returns:

globally unique ID, or null if missing authority or ID.

getUrlPath

public String getUrlPath()

Description copied from class: InvDatasetImpl

Get urlPath for this Dataset

Overrides:

getUrlPath in class InvDatasetImpl

Returns:

urlPath for this Dataset

getUserProperty

public Object getUserProperty(Object p0)

Description copied from class: InvDatasetImpl

Look up the User property having the given key

Overrides:

getUserProperty in class InvDatasetImpl

Parameters:

p0 - property key

Returns:

User property having the given key, or null

getVariables

public List<ThreddsMetadata.Variables> getVariables()

Description copied from class: InvDataset

get Variable metadata

Overrides:

getVariables in class InvDataset

Returns:

List of type ThreddsMetadata.Variables, may be empty

hasAccess

public boolean hasAccess()

Description copied from class: InvDataset

If this dataset has access elements.

Overrides:

hasAccess in class InvDataset

Returns:

true if has access elements.

hasNestedDatasets

public boolean hasNestedDatasets()

Description copied from class: InvDataset

If this dataset has nested datasets.

Overrides:

hasNestedDatasets in class InvDataset

Returns:

true if has nested datasets.

hashCode

public int hashCode()

Description copied from class: InvDatasetImpl

Override Object.hashCode() to implement equals.

Overrides:

hashCode in class InvDatasetImpl

isHarvest

public boolean isHarvest()

Overrides:

isHarvest in class InvDataset

Returns:

if harvest is true

removeDataset

public boolean removeDataset(InvDatasetImpl p0)

Description copied from class: InvDatasetImpl

Remove the given dataset element from this dataset if it is in the dataset.

Overrides:

removeDataset in class InvDatasetImpl

Parameters:

p0 - - the dataset element to be removed

Returns:

true if this dataset contained the given dataset element.

removeService

public void removeService(InvService p0)

Description copied from class: InvDatasetImpl

Remove a service from this dataset.

Overrides:

removeService in class InvDatasetImpl

Parameters:

p0 - remove this

setAlias

public void setAlias(String p0)

Description copied from class: InvDatasetImpl

Set alias for this Dataset

Overrides:

setAlias in class InvDatasetImpl

Parameters:

p0 - ID of another Dataset

setAuthority

public void setAuthority(String p0)

Description copied from class: InvDatasetImpl

Set authorityName for this Dataset

Overrides:

setAuthority in class InvDatasetImpl

Parameters:

p0 - for this Dataset

setCatalog

public void setCatalog(InvCatalog p0)

Description copied from class: InvDatasetImpl

Set the containing catalog; use only for top level dataset.

Overrides:

setCatalog in class InvDatasetImpl

Parameters:

p0 - the containing catalog for the top level dataset.

setCollectionType

public void setCollectionType(CollectionType p0)

Description copied from class: InvDatasetImpl

Set collectionType

Overrides:

setCollectionType in class InvDatasetImpl

Parameters:

p0 - the collection type

setContributors

public void setContributors(List<ThreddsMetadata.Contributor> p0)

Overrides:

setContributors in class InvDatasetImpl

setGeospatialCoverage

public void setGeospatialCoverage(ThreddsMetadata.GeospatialCoverage p0)

Overrides:

setGeospatialCoverage in class InvDatasetImpl

setHarvest

public void setHarvest(boolean p0)

Description copied from class: InvDatasetImpl

Set harvest

Overrides:

setHarvest in class InvDatasetImpl

Parameters:

p0 - true if this dataset should be harvested for Digital Libraries

setID

public void setID(String p0)

Description copied from class: InvDatasetImpl

Set the ID for this Dataset

Overrides:

setID in class InvDatasetImpl

Parameters:

p0 - unique ID

setKeywords

public void setKeywords(List<ThreddsMetadata.Vocab> p0)

Overrides:

setKeywords in class InvDatasetImpl

setLocalMetadata

public void setLocalMetadata(ThreddsMetadata p0)

Overrides:

setLocalMetadata in class InvDatasetImpl

setMark

protected void setMark(boolean p0)

Overrides:

setMark in class InvDatasetImpl

setName

public void setName(String p0)

Description copied from class: InvDatasetImpl

Set name of this Dataset.

Overrides:

setName in class InvDatasetImpl

Parameters:

p0 - of the dataset

setParent

public void setParent(InvDatasetImpl p0)

Description copied from class: InvDatasetImpl

Set the parent dataset.

Overrides:

setParent in class InvDatasetImpl

Parameters:

p0 - parent dataset

setProjects

public void setProjects(List<ThreddsMetadata.Vocab> p0)

Overrides:

setProjects in class InvDatasetImpl

setPublishers

public void setPublishers(List<ThreddsMetadata.Source> p0)

Overrides:

setPublishers in class InvDatasetImpl

setServicesLocal

public void setServicesLocal(List<InvService> p0)

Description copied from class: InvDatasetImpl

Set the list of services attached specifically to this dataset. Discard any previous servies.

Overrides:

setServicesLocal in class InvDatasetImpl

Parameters:

p0 - list of services.

setTimeCoverage

public void setTimeCoverage(DateRange p0)

Overrides:

setTimeCoverage in class InvDatasetImpl

setUrlPath

public void setUrlPath(String p0)

Description copied from class: InvDatasetImpl

Set the urlPath for this InvDatasetImpl

Overrides:

setUrlPath in class InvDatasetImpl

Parameters:

p0 - the urlPath for this InvDatasetImpl

setUserProperty

public void setUserProperty(Object p0,
                            Object p1)

Overrides:

setUserProperty in class InvDatasetImpl

toString

public String toString()

Overrides:

toString in class InvDatasetImpl