C# Class SobekCM.Core.FileSystems.PairTreeStructure

Utility supports the pair tree file / directory structure which the SObekCM instance uses by default to organize the digital resources

Inheritance: iFileSystem

Mostrar archivo Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method	Description
AssociFilePath ( BriefItemInfo DigitalResource ) : string	[TEMPORARY] Get the associated file path (which is essentially the part of the path that appears UNDER the root imaging spot
AssociFilePath ( string BibID, string VID ) : string	[TEMPORARY] Get the associated file path (which is essentially the part of the path that appears UNDER the root imaging spot Why is this temporary?
FileExists ( BriefItemInfo DigitalResource, string FileName ) : bool	Return a flag if the file specified exists within the digital resource
GetFiles ( BriefItemInfo DigitalResource ) : List	Gets the list of all the files associated with this digital resource
PairTreeStructure ( string RootNetworkUri, string RootWebUri ) : System	Constructor for a new instance of the PairTreeStructure class
ReadToEnd ( BriefItemInfo DigitalResource, string FileName ) : string	Read to the end of a (text-based) file and return the contents
Resource_Network_Uri ( BriefItemInfo DigitalResource ) : string	Return the NETWORK uri for a digital resource This makes some presumptions on the type of system in the background
Resource_Network_Uri ( BriefItemInfo DigitalResource, string FileName ) : string	Return the NETWORK uri for a single file in the digital resource This makes some presumptions on the type of system in the background
Resource_Network_Uri ( string BibID, string VID ) : string	Return the NETWORK uri for a digital resource This makes some presumptions on the type of system in the background
Resource_Network_Uri ( string BibID, string VID, string FileName ) : string	Return the NETWORK uri for a single file in the digital resource This makes some presumptions on the type of system in the background
Resource_Web_Uri ( BriefItemInfo DigitalResource ) : string	Return the WEB uri for a digital resource
Resource_Web_Uri ( BriefItemInfo DigitalResource, string FileName ) : string	Return the WEB uri for a file within the digital resource
Resource_Web_Uri ( string BibID, string VID ) : string	Return the WEB uri for a digital resource

Method Details

AssociFilePath() public method

[TEMPORARY] Get the associated file path (which is essentially the part of the path that appears UNDER the root imaging spot

public AssociFilePath ( BriefItemInfo DigitalResource ) : string
DigitalResource	SobekCM.Core.BriefItem.BriefItemInfo	The digital resource object
return	string

AssociFilePath() public method

[TEMPORARY] Get the associated file path (which is essentially the part of the path that appears UNDER the root imaging spot

Why is this temporary?

public AssociFilePath ( string BibID, string VID ) : string
BibID	string	Bibliographic identifier (BibID) for a title within a SobekCM instance
VID	string	Volume identifier (VID) for an item within a SobekCM title
return	string

FileExists() public method

Return a flag if the file specified exists within the digital resource

public FileExists ( BriefItemInfo DigitalResource, string FileName ) : bool
DigitalResource	SobekCM.Core.BriefItem.BriefItemInfo	The digital resource object
FileName	string	Filename to check for
return	bool

GetFiles() public method

Gets the list of all the files associated with this digital resource

public GetFiles ( BriefItemInfo DigitalResource ) : List
DigitalResource	SobekCM.Core.BriefItem.BriefItemInfo	The digital resource object
return	List

PairTreeStructure() public method

Constructor for a new instance of the PairTreeStructure class

public PairTreeStructure ( string RootNetworkUri, string RootWebUri ) : System
RootNetworkUri	string	Root network location for the digital resource files
RootWebUri	string	Root web URL for the digital resource files folder
return	System

ReadToEnd() public method

Read to the end of a (text-based) file and return the contents

public ReadToEnd ( BriefItemInfo DigitalResource, string FileName ) : string
DigitalResource	SobekCM.Core.BriefItem.BriefItemInfo	The digital resource object
FileName	string	Name of the file to open, and read
return	string

Resource_Network_Uri() public method

Return the NETWORK uri for a digital resource

This makes some presumptions on the type of system in the background

public Resource_Network_Uri ( BriefItemInfo DigitalResource ) : string
DigitalResource	SobekCM.Core.BriefItem.BriefItemInfo	The digital resource object
return	string

Resource_Network_Uri() public method

Return the NETWORK uri for a single file in the digital resource

This makes some presumptions on the type of system in the background

public Resource_Network_Uri ( BriefItemInfo DigitalResource, string FileName ) : string
DigitalResource	SobekCM.Core.BriefItem.BriefItemInfo	The digital resource object
FileName	string	Filename to get network URI for
return	string

Resource_Network_Uri() public method

Return the NETWORK uri for a digital resource

This makes some presumptions on the type of system in the background

public Resource_Network_Uri ( string BibID, string VID ) : string
BibID	string	Bibliographic identifier (BibID) for a title within a SobekCM instance
VID	string	Volume identifier (VID) for an item within a SobekCM title
return	string

Resource_Network_Uri() public method

Return the NETWORK uri for a single file in the digital resource

This makes some presumptions on the type of system in the background

public Resource_Network_Uri ( string BibID, string VID, string FileName ) : string
BibID	string	Bibliographic identifier (BibID) for a title within a SobekCM instance
VID	string	Volume identifier (VID) for an item within a SobekCM title
FileName	string	Filename to get network URI for
return	string

Resource_Web_Uri() public method

Return the WEB uri for a digital resource

public Resource_Web_Uri ( BriefItemInfo DigitalResource ) : string
DigitalResource	SobekCM.Core.BriefItem.BriefItemInfo	The digital resource object
return	string

Resource_Web_Uri() public method

Return the WEB uri for a file within the digital resource

public Resource_Web_Uri ( BriefItemInfo DigitalResource, string FileName ) : string
DigitalResource	SobekCM.Core.BriefItem.BriefItemInfo	The digital resource object
FileName	string	Name of the resource file
return	string

Resource_Web_Uri() public method

Return the WEB uri for a digital resource

public Resource_Web_Uri ( string BibID, string VID ) : string
BibID	string	Bibliographic identifier for the resource in question
VID	string	Volume identifier for the resource in question
return	string