Abaris-notat Teknisk beskrivelse av kodeverkskomponent for ICPC-2

Transkript

1 Tittel: Dato: Forfatter: Lars Tungen : 000 Sider/bilag: 5/0 Versjon: A Filnavn: E:\PROSJEKTER\KITH\ICPC\2004\DOKUMENTER\TEKNISK BESKRIVELSE AV KODEVERKSKOMPONENT FOR ICPC.DOC Innhold: 1. Teknisk plattform Grensesnitt / API Implementasjon av ICPC kodeverkskomponent i andre systemer Opprette en instans av ICPC-2 kodeverkskomponent Initialisere kodeverkskomponent Aktivering av søk Eksempel (Visual Basic)...4 Sendes til: KITH AS Kopi til: Side 1 av 5

2 1. Teknisk plattform ICPC-2 kodeverkskomponent er implementert som en ActiveX COM komponent som er kompatibel med Windows 95, 98, ME, NT, XP og.net. Komponenten er implementert i Visual Basic 6.0, men vil kunne benyttes av alle programmer som støtter ActiveX/COM grensesnittet. ICPC-2 kodeverket distribueres sammen med komponenten som XML og HTML filer. 2. Grensesnitt / API Komponenten heter KodeverksKomponent.dll og inneholder et objekt som heter Icpc. Icpc objektet et enkelt grensesnitt som består av to metoder og tre attributter: Grensensitt for objektet KodeverksKomponent.Icpc Navn Type Beskrivelse Initialiser Metode Initialiserer objektet med ICPC-2 datafiler ved at disse leses inn i programminnet. Vis Funksjon Funksjon uten parametere som returnerer Boolean. Viser søkebildet for ICPC-2. Returnerer True hvis brukeren har valgt kode og term, eller False hvis ingenting ble valgt. Kode Attributt Datatype String. Inneholder koden som brukeren har valgt hvis funksjonen Vis har returnert True. Korttekst Attributt Datatype String. Inneholder korttekst til koden som brukeren har valgt hvis funksjonen Vis har returnert True. ValgtTerm Attributt Datatype String. Inneholder termen som brukeren har valgt hvis funksjonen Vis har returnert True. 3. Implementasjon av ICPC-2 kodeverkskomponent i andre systemer Aktivering av ICPC-2 søkeverktøy fra andre systemer krever bare noen få programlinjer og består av følgende steg: 1. Opprette en instans av kodeverkskomponenten 2. Initialisere kodeverkskomponenten 3. Vise søkedialog 4. Hente resultat fra søket 3.1 Opprette en instans av ICPC-2 kodeverkskomponent ICPC-2 kodeverkskomponenten heter KodeverksKomponent.Icpc og kan opprettes med f.eks Visual Basic funksjonen CreateObject slik: Dim objicpc As Object Set objicpc = CreateObject( KodeverksKomponent.Icpc ) Side 2 av 5

3 Alternativt kan tidlig binding og typesjekk benyttes ved å deklarere komponenten med riktig type og benytte New operator: Dim objicpc As KodeverksKomponent.Icpc Set objicpc = New KodeverksKomponent.Icpc 3.2 Initialisere kodeverkskomponent ICPC-2 kodeverkskomponenten må initialiseres ved at datafilene for ICPC-2 leses inn. Dette kan enten gjøres eksplisitt ved å kalle metoden Initialiser på komponenten eller implisitt ved første gangs visning av søkedialog. Fordelen ved å kalle Initialiser eksplisitt er at det gir kallende program muligheten til å gjøre unna den tidkrevende initialiseringen før brukeren aktiverer søk. Metoden gir også mulighet til å spesifisere plasseringen av filkatalogen til datafilene som komponenten trenger. Datakatalog er eneste parameter til denne metoden og det er ikke obligatorisk. Hvis datakatalog mangler benytter komponenten standard datakatalog som er en underkatalog der komponenten er installert. Komponenten initialiserer seg selv ved første gangs visning av søkedialog hvis kallende program ikke har initialisert komponenten ved å kalle Initialiser. Eksempel på initalisering: objicpc.initialiser Eksempel på initialisering med datakatalog angitt: objicpc.initialiser c:\icpc\datafiler 3.3 Aktivering av søk Etter at kodeverkskomponenten er opprettet (og eventuelt initialisert) aktiveres søk ved å kalle funksjonen Vis. Denne viser søkebildet og lar brukeren søke og navigere i kodeverket. Søkebildet holder fokusen i programmet inntil brukeren velger kode/term eller avbryter søket. Funksjonen returnerer boolsk True hvis brukeren har valgt kode/term. Hvis søket er avbrutt er returverdien False. Har brukeren valgt kode/term kan koden hentes ut via egenskapen Kode på komponenten. Korttekst til valgt kode finnes alltid i egenskapen Korttekst. Hvis brukeren har valgt en underterm kan denne hentes ut i ValgtTerm, ellers er dette en tom streng. Eksempel: Side 3 av 5

4 If objicpc.vis Then Returnerte True -> Kode og evt. term valgt MsgBox Valgt kode: + objicpc.kode + + objicpc.korttekst Sjekk om term er valgt If objicpc.valgtterm <> Then Vis valgt term MsgBox Valgt Term: + objicpc.valgtterm Else Returnerte False -> søk avbrutt MsgBox Ingen kode valgt / søk avbrutt! 4. Eksempel (Visual Basic) Side 4 av 5

5 Option Explicit Private mobjsok As New KodeverksKomponent.icpc Private Sub cmdsearch_click() On Error GoTo ErrorHandler Vis søkebilde If mobjsok.vis Then Brukeren har valgt kode og term lblkode.caption = mobjsok.kode lblkorttekst.caption = mobjsok.korttekst lblvalgtterm.caption = mobjsok.valgtterm Else Ingen kode og term valgt lblkode.caption = "" lblkorttekst.caption = "" lblvalgtterm.caption = "" Exit Sub ErrorHandler: MsgBox Err.Description End Sub Side 5 av 5