C# Class SobekCM.Resource_Object.Metadata_File_ReaderWriters.EAD_File_ReaderWriter

Reads the container list and grabs the entire description section from an EAD file into an existing item for display within SobekCM
Inheritance: iMetadata_File_ReaderWriter
Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method Description
Read_Metadata ( Stream Input_Stream, SobekCM_Item Return_Package, object>.Dictionary Options, string &Error_Message ) : bool

Reads metadata from an open stream and saves to the provided item/package

This reader accepts two option values. 'EAD_File_ReaderWriter:XSL_Location' gives the location of a XSL file, which can be used to transform the description XML read from this EAD into HTML (or another format of XML). 'EAD_File_ReaderWriter:Analyze_Description' indicates whether to analyze the description section of the EAD and read it into the item. (Default is TRUE).

Read_Metadata ( string MetadataFilePathName, SobekCM_Item Return_Package, object>.Dictionary Options, string &Error_Message ) : bool

Reads metadata from an existing metadata file and saves to the provided item/package

This reader accepts two option values. 'EAD_File_ReaderWriter:XSL_Location' gives the location of a XSL file, which can be used to transform the description XML read from this EAD into HTML (or another format of XML). 'EAD_File_ReaderWriter:Analyze_Description' indicates whether to analyze the description section of the EAD and read it into the item. (Default is TRUE).

Write_Metadata ( TextWriter Output_Stream, SobekCM_Item Item_To_Save, object>.Dictionary Options, string &Error_Message ) : bool

Writes the formatted metadata from the provided item to a TextWriter (usually to an output stream)
Write_Metadata ( string MetadataFilePathName, SobekCM_Item Item_To_Save, object>.Dictionary Options, string &Error_Message ) : bool

Writes the formatted metadata from the provided item to a file

Private Methods

Method Description
Clean_Text_Block ( string InnerXML ) : string
Trim_Final_Punctuation ( string ToBeTrimmed ) : string

Method Details

Read_Metadata() public method

Reads metadata from an open stream and saves to the provided item/package
This reader accepts two option values. 'EAD_File_ReaderWriter:XSL_Location' gives the location of a XSL file, which can be used to transform the description XML read from this EAD into HTML (or another format of XML). 'EAD_File_ReaderWriter:Analyze_Description' indicates whether to analyze the description section of the EAD and read it into the item. (Default is TRUE).
public Read_Metadata ( Stream Input_Stream, SobekCM_Item Return_Package, object>.Dictionary Options, string &Error_Message ) : bool
Input_Stream Stream Open stream to read metadata from
Return_Package SobekCM_Item Package into which to read the metadata
Options object>.Dictionary Dictionary of any options which this metadata reader/writer may utilize
Error_Message string [OUTPUT] Explanation of the error, if an error occurs during reading
return bool

Read_Metadata() public method

Reads metadata from an existing metadata file and saves to the provided item/package
This reader accepts two option values. 'EAD_File_ReaderWriter:XSL_Location' gives the location of a XSL file, which can be used to transform the description XML read from this EAD into HTML (or another format of XML). 'EAD_File_ReaderWriter:Analyze_Description' indicates whether to analyze the description section of the EAD and read it into the item. (Default is TRUE).
public Read_Metadata ( string MetadataFilePathName, SobekCM_Item Return_Package, object>.Dictionary Options, string &Error_Message ) : bool
MetadataFilePathName string Path and name of the metadata file to read
Return_Package SobekCM_Item Package into which to read the metadata
Options object>.Dictionary Dictionary of any options which this metadata reader/writer may utilize
Error_Message string [OUTPUT] Explanation of the error, if an error occurs during reading
return bool

Write_Metadata() public method

Writes the formatted metadata from the provided item to a TextWriter (usually to an output stream)
public Write_Metadata ( TextWriter Output_Stream, SobekCM_Item Item_To_Save, object>.Dictionary Options, string &Error_Message ) : bool
Output_Stream System.IO.TextWriter
Item_To_Save SobekCM_Item Package with all the metadata to save
Options object>.Dictionary Dictionary of any options which this metadata reader/writer may utilize
Error_Message string [OUTPUT] Explanation of the error, if an error occurs during write
return bool

Write_Metadata() public method

Writes the formatted metadata from the provided item to a file
public Write_Metadata ( string MetadataFilePathName, SobekCM_Item Item_To_Save, object>.Dictionary Options, string &Error_Message ) : bool
MetadataFilePathName string Path and name of the metadata file to write
Item_To_Save SobekCM_Item Package with all the metadata to save
Options object>.Dictionary Dictionary of any options which this metadata reader/writer may utilize
Error_Message string [OUTPUT] Explanation of the error, if an error occurs during write
return bool