|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectthredds.catalog.InvDataset
thredds.catalog.InvDatasetImpl
thredds.catalog.InvCatalogRef
public class InvCatalogRef
A reference to a InvCatalog. The referenced catalog is not read until getDatasets() is called. A client will see the referenced catalog as a nested dataset.
The client can also do asynchronous reading, if the InvCatalogFactory supports it, and if readAsynch() is used.Parent relationship: ds -> catRef -- catalog ^ top -> ds ... ParentView relationship: ds -> catRef -> top -> ds ... (or) -> ds if UseProxy
for API, thredds.catalog.ui.CatalogTreeView as example to read asynchronously
Field Summary |
---|
Fields inherited from class thredds.catalog.InvDatasetImpl |
---|
log, mark, ncmlElement, tm, tmi, tmi6 |
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, variables |
Constructor Summary | |
---|---|
InvCatalogRef(InvDatasetImpl parent,
String title,
String href)
Constructor. |
Method Summary | |
---|---|
boolean |
equals(Object o)
InvDatasetImpl elements with same values are equal. |
InvDatasetImpl |
findDatasetByName(String p0)
Find an immediate child dataset by its name. |
String |
findProperty(String p0)
Find named property. |
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. |
String |
getAlias()
|
String |
getAuthority()
Get authority for this Dataset, may be null. |
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 |
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. |
List<ThreddsMetadata.Vocab> |
getProjects()
get Projects metadata |
List<InvProperty> |
getProperties()
Get all properties for this dataset. |
InvDatasetImpl |
getProxyDataset()
This triggers a read of the referenced catalog the first time its called. |
List<ThreddsMetadata.Source> |
getPublishers()
get Publisher metadata |
InvService |
getServiceDefault()
Find the default service for this dataset and its children. |
DateRange |
getTimeCoverage()
get time coverage |
String |
getUniqueID()
If this dataset has an authority and an ID, then the concatenation of them is the globally unique ID. |
URI |
getURI()
|
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 |
String |
getXlinkHref()
|
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 |
isRead()
|
void |
readAsynch(InvCatalogFactory factory,
CatalogSetCallback caller)
Read the referenced catalog asynchronously, if the catalog factory supports it. |
void |
release()
Release resources - undo the read of the catalog. |
void |
setXlinkHref(String href)
|
Methods inherited from class thredds.catalog.InvDataset |
---|
findAccess, getCatalogUrl, getHistory, getParentCatalog, getProcessing, getRestrictAccess, getRights, getSubsetUrl, getSummary, getVariables |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public InvCatalogRef(InvDatasetImpl parent, String title, String href)
parent
- : parent datasettitle
- : display name of collectionhref
- : URL to another catalogMethod Detail |
---|
public String getXlinkHref()
public void setXlinkHref(String href)
public URI getURI()
public List<InvDataset> getDatasets()
getDatasets
in class InvDataset
public boolean isRead()
public InvDatasetImpl getProxyDataset()
public void release()
public boolean finish()
InvDatasetImpl
finish
in class InvDatasetImpl
public void readAsynch(InvCatalogFactory factory, CatalogSetCallback caller)
factory
- : use this catalog factorycaller
- when catalog is readCatalogSetCallback
public boolean equals(Object o)
InvDatasetImpl
equals
in class InvDatasetImpl
public int hashCode()
InvDatasetImpl
hashCode
in class InvDatasetImpl
public InvDatasetImpl findDatasetByName(String p0)
InvDataset
findDatasetByName
in class InvDataset
p0
- match on this name
public String findProperty(String p0)
InvDataset
findProperty
in class InvDataset
p0
- match on this name
public InvService findService(String p0)
InvDataset
findService
in class InvDataset
p0
- match this name
public InvAccess getAccess(ServiceType p0)
InvDataset
getAccess
in class InvDataset
p0
- find this ServiceType
public List<InvAccess> getAccess()
InvDataset
getAccess
in class InvDataset
public String getAlias()
getAlias
in class InvDatasetImpl
public String getAuthority()
InvDataset
getAuthority
in class InvDataset
public CollectionType getCollectionType()
InvDataset
getCollectionType
in class InvDataset
public List<ThreddsMetadata.Contributor> getContributors()
InvDataset
getContributors
in class InvDataset
public List<ThreddsMetadata.Source> getCreators()
InvDataset
getCreators
in class InvDataset
public DataFormatType getDataFormatType()
InvDataset
getDataFormatType
in class InvDataset
public FeatureType getDataType()
InvDataset
getDataType
in class InvDataset
public List<DateType> getDates()
InvDataset
getDates
in class InvDataset
public List<InvDocumentation> getDocumentation()
InvDataset
getDocumentation
in class InvDataset
public String getDocumentation(String p0)
InvDataset
getDocumentation
in class InvDataset
p0
- find this type of documentation
public String getFullName()
InvDataset
getFullName
in class InvDataset
public ThreddsMetadata.GeospatialCoverage getGeospatialCoverage()
InvDataset
getGeospatialCoverage
in class InvDataset
public String getID()
InvDataset
getID
in class InvDataset
public List<ThreddsMetadata.Vocab> getKeywords()
InvDataset
getKeywords
in class InvDataset
protected boolean getMark()
InvDatasetImpl
getMark
in class InvDatasetImpl
public List<InvMetadata> getMetadata(MetadataType p0)
InvDataset
getMetadata
in class InvDataset
p0
- find this metadata type
public List<InvMetadata> getMetadata()
InvDataset
getMetadata
in class InvDataset
public String getName()
InvDataset
getName
in class InvDataset
public InvDataset getParent()
InvDataset
getParent
in class InvDataset
public List<ThreddsMetadata.Vocab> getProjects()
InvDataset
getProjects
in class InvDataset
public List<InvProperty> getProperties()
InvDataset
getProperties
in class InvDataset
public List<ThreddsMetadata.Source> getPublishers()
InvDataset
getPublishers
in class InvDataset
public InvService getServiceDefault()
InvDataset
getServiceDefault
in class InvDataset
public DateRange getTimeCoverage()
InvDataset
getTimeCoverage
in class InvDataset
public String getUniqueID()
InvDataset
getUniqueID
in class InvDataset
public String getUrlPath()
InvDatasetImpl
getUrlPath
in class InvDatasetImpl
public Object getUserProperty(Object p0)
InvDatasetImpl
getUserProperty
in class InvDatasetImpl
p0
- property key
public List<ThreddsMetadata.Variables> getVariables()
InvDataset
getVariables
in class InvDataset
public boolean hasAccess()
InvDataset
hasAccess
in class InvDataset
public boolean hasNestedDatasets()
InvDataset
hasNestedDatasets
in class InvDataset
public boolean isHarvest()
isHarvest
in class InvDataset
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |