Metadata Extraction Tool,Tutorial：元数据提取工具教程

Page

PAGE

2

of

NUMPAGES

8

MetadataExtractionTool

InstallationGuide

Version:3.4.

MetadataExtractionTool

InstallationGuide

Version:3.4.

TableofContents

TOC\o\h\z\t"Heading2,2"

WhatistheMetadataExtractionTool

3

SourceDirectoryStructure

4

BinaryDirectoryStructure

4

InstallingfromSource

5

InstallingfromBinary

5

ConfiguringyourEnvironment

5

RunningtheTool

5

Troubleshooting

7

WhatistheMetadataExtractionTool

ThemetadataextractiontoolisatoolbuiltbySytecResourcesfortheNationalLibraryofNewZealandTePunaMātaurangaoAotearoa(NationalLibrary)toprocessdigitalmasterfilesandextractmetadataaboutthosefiles.Metadataisdescriptiveinformationaboutanobject–nottheobjectitself.InthiscasemetadatainformationaboutaImagewouldbethingslikesize,colours,resolution,etc…Therearetwooutputformatsthatanoutputmetadatafilecantake

Nativeform.AnXML(ExtensibleMark-upLanguage)filebasedonaDTD(DocumentTypeDefinition)thatreflectsallinformationavailablefromthedigitalmaster.

NationalLibraryPreservationMetadataDataDictionary–nlnz-presmet.xsd.Thisistheprimaryformat.

FormoreinformationaboutanyofthesefileformatsseetheSolutionArchitectureorSoftwareArchitecturedocumentsforthisextractiontool.Note:TheProofofConceptoutputtypesofdemta.dtdandpmeta.dtdhavebeendeprecated;theyarenotsupportedintheproductiontool.

SourceDirectoryStructure

Thesourcedirectorystructureisasfollows:

Directory

Description

BASE

Containsthebuild.xmlandlicensefiles.IsthedestinationfortheZIPfilesforthedistributables.

BASE/dist

Thebuilddirectoryforassemblingthedistributables.Thisdirectorywillbedeletedandrecreatedwhenrunningthebuildscript.

BASE/docs

Containsthemaindocumentationfortheapplication.

BASE/docs/apidocs

Containsthejavadocsfortheapplication.

BASE/legal

ContainsthelicenseandnoticefilesforallthelibrariesdistributedwiththeMetadataMetadataExtractionTool.

BASE/lib

ContainsthelibrariesthattheMetadataMetadataExtractionToolisdependenton.

BASE/src

Rootdirectoryforallsourceelements.

BASE/src/java

RootdirectoryfortheJavasourcecode.

BASE/src/help

RootdirectoryfortheonlineHTMLhelpguide.

BASE/src/images

RootdirectoryfortheimagesusedintheGUI.

BASE/src/java

RootdirectoryfortheJavasourcecode.

BASE/src/scripts

Rootdirectoryforthebatchfilesandshellscriptsusedtoruntheapplication.

BASE/src/xml

RootdirectoryfortheXMLconfigurationfiles,DTDsandXSLTfiles.

BASE/target

ThedestinationdirectoryforthejavacANTtask.ThisdirectorywillbedeletedandrecreatedeachtimetheANTscriptisrun.

BinaryDirectoryStructure

Thebinarydistributable’sdirectoriesaredescribedbelow:

Directory

Description

BASE

Holdstheconfigurationfile,MetadataExtractionToollicensefileandbatch/shellscripts.

BASE/adapters

Holdsthefullsetofadapters.

BASE/help_files

Containstheonlinehelpfiles.

BASE/installed-adapters

ContainstheJARfilesforalloftheinstalledadapters.

BASE/legal

ContainsthelicenseandnoticefilesforallthelibrariesdistributedwiththeMetadataExtractor.

BASE/lib

ContainsthelibrariesthattheMetadataExtractorisdependenton.

BASE/xml

RootdirectoryfortheXMLconfigurationfiles,DTDsandXSLTfiles.

InstallingfromSource

TheMetadataExtractionToolisbuiltfromsourceusingANT.ANTcanbedownloadedfrom

/

.Thebuildfilehasbeentestedagainstversion1.6.1.

WithANTintheclasspath,changeintotherootdirectoryoftheMetadataExtractionToolandrunant.Thedefaulttargetwillcleanthedirectories,compilethecode,andproducethebinaryandsourcedistributables.

ToregeneratetheJavaDocs,runantjavadoc.

WhenANThasfinished,abinarydistributablewillbefoundin

BASE\metadata-bin-2-0.zip

Onceabinarydistributableversionisbuilt,youcaninstallfrombinaryasdescribedbelow.

InstallingfromBinary

UnziptheZIPfiletoadesiredlocation.Itisstronglyrecommendedtochooseadirectorynamethatdoesnotcontainspaces.

ConfiguringyourEnvironment

Configurationofthetoolisautomaticassumingthefollowing:

ForWindows,Javaisinthepath.

ForLinux,theJAVA_HOMEenvironmentvariableisset.

Ifthesearetrue,orifyouareunsure,justrunthemetadata.batormetadata.shscripts.

TheWindowsscriptsassumethatJavaisinyourpathandcanbefoundwithoutspecifyingitsexactlocation.Ifthemetadata.batorextract.batscriptsfailtorun,youmayneedtoeditthemandprovideanexplicitpathforyourJavainstallation.

TheLinuxscriptsrequiretheJAVA_HOMEvariabletobeset.Ifitisnotset,youcanadditintothemetadata.shandextract.shscriptsasfollows,beingsuretoreplacethepathwiththeappropriatepathforyourJavainstallation.

JAVA_HOME=/usr/java/jdk1.5.0

exportJAVA_HOME

Bothversionsattempttoguesstheinstallationdirectoryandwillattempttoconfiguretheinitialconfig.xmlfilewithoutmanualintervention.Ifthisfails,youwillbeaskedtoeditthescriptsandsettheMETAHOMEvariable.

RunningtheTool

Torunthetool,changeintotheBASEdirectoryandrunmetadata.batormetadata.shtoruntheMetadataExtractionTool.

Ifyouwishtorunthetoolmanually,orembeditinanotherapplication,youmustsettheclasspathtocontain:

AllJARsintheBASE/libdirectory.

TheBASEdirectoryitself–thisiswheretheconfig.xmlfileislocated.

Oncetheclasspathisconfiguredcorrectly,youcanrunthetoolusing:

$JAVA_HOME/bin/javat.natlib.meta.ui.Main(Linux)

%JAVA_HOME%\bin\javat.natlib.meta.ui.Main(Windows)

Troubleshooting

Thefollowingtablelistsasetofcommonlyencounteredissuesandtherequiredresolution.Themostcommonissuesarearoundthedirectorylocationsspecifiedintheconfigurationfile.FollowingtheinstructionsintheConfigurationsectionaboveshouldavoidanyofthoseissues.

Ifyougetanerrorduringharvesting,youwillneedtousetheLogViewertogetadditionalinformationabouttheerror,orconsulttheOutput.logfile.

Symptom

Description

Solution

Onstartup,youseethemessage:

Thesystemcannotfindthepathspecified.

or

-bash:java:commandnotfound

TheJAVA_HOMEvariableisnotsetcorrectly.

SettheJAVA_HOMEvariableaspertheinstructionsintheSettingJAVA_HOMEEnvironmentVariablesectionofthisdocument.

Onstartup,youseeerrorssuchas:

LOG:1000,Adapterclasst.natlib.adapter.bmp.BitmapAdapternotfound

java.lang.ClassNotFoundException:t.natlib.adapter.bmp.BitmapAdapter

Thejar-locationintheconfig.xmlfileisnotsetcorrectly.

Editconfig.xmlinthebasedirectoryandensurethatthejar-locationURLattributeispointingatavaliddirectory.

Onstartup,youseeanerrorsuchas:

java.io.FileNotFoundException:

METADATA_BASE\logs\nlnz_Jan302007_171007.log

Thelog-direlementinconfig.xmlpointstoadirectorythatdoesnotexist.

Editconfig.xmlinthebasedirectoryandensurethatthedirattributeofthelog-direlementissettoanexistingdirectory.

Notethattherearetwooccurrencesofthelog-direlementinthedefaultconfiguration.Oneatthetopoftheconfigurationfile,andoneintheprofilesectiontowardsthebottom.

Duringharvest,youseeanerrorsuchas:

java.io.FileNotFoundException:METADATA_BASE\harvested\…\filename.xml

atjava.io.FileOutputStream.open(NativeMethod)

atjava.io.FileOutputStream.<init>(FileOutputStream.java:179)

atjava.io.FileOutputStream.<init>(FileOutputStream.java:131)

att.natlib.meta.harv