File: HDF5ObjectInformation.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 (136 lines) | stat: -rw-r--r-- 3,444 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
/*
 * 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 hdf.hdf5lib.structs.H5O_info_t;

/**
 * Information about an object in an HDF5 file.
 * 
 * @author Bernd Rinn
 */
public final class HDF5ObjectInformation extends HDF5CommonInformation
{

    private final long fileNumber;

    private final long address;

    private final int referenceCount;

    private final long creationTime;

    private final long numberOfAttributes;

    HDF5ObjectInformation(String path, HDF5ObjectType objectType, H5O_info_t info)
    {
        super(path, objectType);
        this.fileNumber = info.fileno;
        this.address = info.addr;
        this.referenceCount = info.rc;
        this.creationTime = info.ctime;
        this.numberOfAttributes = info.num_attrs;
    }

    /**
     * Returns the file number that the object is in. Can be useful when external links are
     * involved.
     */
    public long getFileNumber()
    {
        return fileNumber;
    }

    /**
     * Returns the address of the object in the file. If the address of two links is the same, then
     * they point to the same object. Can be used to spot hard or soft links.
     */
    public long getAddress()
    {
        return address;
    }

    /**
     * Returns the number of references that point to this object. (Number of hard links that point
     * to the object).
     */
    public int getReferenceCount()
    {
        return referenceCount;
    }

    /**
     * Returns the time of creation of this object (as number of seconds since start of the epoch).
     * Note that this only works for data set, for groups, this will always return 0.
     */
    public long getCreationTime()
    {
        return creationTime;
    }

    /**
     * Returns the number of attributes that is object has.
     */
    public long getNumberOfAttributes()
    {
        return numberOfAttributes;
    }

    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((path == null) ? 0 : path.hashCode());
        result = prime * result + ((int) address);
        return result;
    }

    @Override
    public boolean equals(Object obj)
    {
        if (this == obj)
        {
            return true;
        }
        if (obj == null)
        {
            return false;
        }
        if (getClass() != obj.getClass())
        {
            return false;
        }
        final HDF5ObjectInformation other = (HDF5ObjectInformation) obj;
        if (path == null)
        {
            if (other.path != null)
            {
                return false;
            }
        } else if (path.equals(other.path) == false)
        {
            return false;
        } 
        if (other.address != address)
        {
            return false;
        }
        return true;
    }

}