File: HDF5CommonInformation.java

package info (click to toggle)
libsis-jhdf5-java 19.04.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 8,668 kB
  • sloc: java: 79,644; ansic: 18,986; sh: 309; makefile: 49; xml: 12
file content (158 lines) | stat: -rw-r--r-- 4,222 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * Copyright 2007 - 2018 ETH Zuerich, CISD and SIS.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ch.systemsx.cisd.hdf5;

import static hdf.hdf5lib.HDF5Constants.H5L_TYPE_EXTERNAL;
import static hdf.hdf5lib.HDF5Constants.H5L_TYPE_SOFT;
import static hdf.hdf5lib.HDF5Constants.H5O_TYPE_DATASET;
import static hdf.hdf5lib.HDF5Constants.H5O_TYPE_GROUP;
import static hdf.hdf5lib.HDF5Constants.H5O_TYPE_NAMED_DATATYPE;
import static hdf.hdf5lib.HDF5Constants.H5O_TYPE_NTYPES;
import hdf.hdf5lib.exceptions.HDF5JavaException;

/**
 * The common super class of {@link HDF5LinkInformation} and {@link HDF5ObjectInformation}. 
 *
 * @author Bernd Rinn
 */
class HDF5CommonInformation
{

    protected final String path;
    protected final HDF5ObjectType type;

    static HDF5ObjectType objectTypeIdToObjectType(final int objectTypeId)
    {
        if (-1 == objectTypeId)
        {
            return HDF5ObjectType.NONEXISTENT;
        } else if (H5O_TYPE_GROUP == objectTypeId)
        {
            return HDF5ObjectType.GROUP;
        } else if (H5O_TYPE_DATASET == objectTypeId)
        {
            return HDF5ObjectType.DATASET;
        } else if (H5O_TYPE_NAMED_DATATYPE == objectTypeId)
        {
            return HDF5ObjectType.DATATYPE;
        } else if (objectTypeId >= H5O_TYPE_NTYPES)
        {
            final int linkTypeId = objectTypeId - H5O_TYPE_NTYPES;
            if (linkTypeId == H5L_TYPE_SOFT)
            {
                return HDF5ObjectType.SOFT_LINK;
            } else if (linkTypeId == H5L_TYPE_EXTERNAL)
            {
                return HDF5ObjectType.EXTERNAL_LINK;
            }
        }
        return HDF5ObjectType.OTHER;
    }

    HDF5CommonInformation(String path, HDF5ObjectType type)
    {
        assert path != null;
        assert type != null;

        this.path = path;
        this.type = type;
    }

    /**
     * @throws HDF5JavaException If the link does not exist.
     */
    public void checkExists() throws HDF5JavaException
    {
        if (exists() == false)
        {
            throw new HDF5JavaException("Link '" + getPath() + "' does not exist.");
        }
    }

    /**
     * Returns the path of this link in the HDF5 file.
     */
    public String getPath()
    {
        return path;
    }

    /**
     * Returns the parent of the path of this link the HDF5 file. If this link corresponds to the
     * root, then this method will return the root ("/") itself.
     */
    public String getParentPath()
    {
        final int lastSlashIndex = path.lastIndexOf('/');
        if (lastSlashIndex <= 0)
        {
            return "/";
        } else
        {
            return path.substring(0, lastSlashIndex);
        }
    }

    /**
     * Returns the name of this link in the HDF5 file (the path without the parent).
     */
    public String getName()
    {
        return path.substring(path.lastIndexOf('/') + 1);
    }

    /**
     * Returns the type of this link.
     */
    public HDF5ObjectType getType()
    {
        return type;
    }

    /**
     * Returns <code>true</code>, if the link exists.
     */
    public boolean exists()
    {
        return HDF5ObjectType.exists(type);
    }

    /**
     * Returns <code>true</code>, if the link is a group.
     */
    public boolean isGroup()
    {
        return HDF5ObjectType.isGroup(type);
    }

    /**
     * Returns <code>true</code>, if the link is a data set.
     */
    public boolean isDataSet()
    {
        return HDF5ObjectType.isDataSet(type);
    }

    /**
     * Returns <code>true</code>, if the link is a data type.
     */
    public boolean isDataType()
    {
        return HDF5ObjectType.isDataType(type);
    }

}