Mercurial > hg > orthanc-java

comparison JavaSDK/be/uclouvain/orthanc/FindMatcher.java @ 0:3ecef5782f2c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
initial commit
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 18 Oct 2023 17:59:44 +0200
parents
children 26c08ff926a3
comparison
equal deleted inserted replaced
-1:000000000000 0:3ecef5782f2c
1 package be.uclouvain.orthanc;
2
3 /**
4 * SPDX-FileCopyrightText: 2023 Sebastien Jodogne, UCLouvain, Belgium
5 * SPDX-License-Identifier: GPL-3.0-or-later
6 */
7
8 /**
9 * Java plugin for Orthanc
10 * Copyright (C) 2023 Sebastien Jodogne, UCLouvain, Belgium
11 *
12 * This program is free software: you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License as
14 * published by the Free Software Foundation, either version 3 of the
15 * License, or (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see http://www.gnu.org/licenses/.
24 **/
25
26
27 /**
28 * Matcher for DICOM C-FIND query
29 **/
30 public class FindMatcher {
31 private long self;
32
33 /**
34 * Construct a Java object wrapping a C object that is managed by Orthanc.
35 * @param self Pointer to the C object.
36 **/
37 protected FindMatcher(long self) {
38 if (self == 0) {
39 throw new IllegalArgumentException("Null pointer");
40 } else {
41 this.self = self;
42 }
43 }
44
45 /**
46 * Return the C object that is associated with this Java wrapper.
47 * @return Pointer to the C object.
48 **/
49 protected long getSelf() {
50 return self;
51 }
52
53 @Override
54 protected void finalize() throws Throwable {
55 dispose();
56 super.finalize();
57 }
58
59 /**
60 * Manually deallocate the C object that is associated with this Java wrapper.
61 *
62 * This method can be used to immediately deallocate the C object,
63 * instead of waiting for the garbage collector to dispose the Java wrapper.
64 **/
65 public void dispose() {
66 if (self != 0) {
67 NativeSDK.OrthancPluginFreeFindMatcher(self);
68 self = 0;
69 }
70 }
71
72 /**
73 * Create a C-Find matcher.
74 *
75 * This function creates a "matcher" object that can be used to check whether a
76 * DICOM instance matches a C-Find query. The C-Find query must be expressed as a
77 * DICOM buffer.
78 *
79 * @param query The C-Find DICOM query.
80 * @return The newly constructed object.
81 **/
82 public static FindMatcher createFindMatcher(
83 byte[] query) {
84 return new FindMatcher(NativeSDK.OrthancPluginCreateFindMatcher(query));
85 }
86
87
88 /**
89 * Test whether a DICOM instance matches a C-Find query.
90 *
91 * This function checks whether one DICOM instance matches C-Find matcher that was
92 * previously allocated using OrthancPluginCreateFindMatcher().
93 *
94 * @param dicom The DICOM instance to be matched.
95 * @return 1 if the DICOM instance matches the query, 0 otherwise.
96 **/
97 public int findMatcherIsMatch(
98 byte[] dicom) {
99 return NativeSDK.OrthancPluginFindMatcherIsMatch(self, dicom);
100 }
101
102 }